diff --git a/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DataGenerator.java b/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DataGenerator.java index c76c332..a509bd4 100644 --- a/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DataGenerator.java +++ b/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DataGenerator.java @@ -18,6 +18,12 @@ * and https://npm.runkit.com/d3-random *

* Alternatively I could simply use the `gwt-d3` library, but just a very small piece was needed. + * + *

+ * MIT License + *

+ * Copyright (c) 2018 Marcin Szalomski + *

*/ @JsType class DataGenerator { diff --git a/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DemoApp.java b/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DemoApp.java index 3719f94..6b4d099 100644 --- a/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DemoApp.java +++ b/examples/simple-hexbinlayer-demo/src/main/java/pl/itrack/leafletd3demo/client/DemoApp.java @@ -16,7 +16,16 @@ import static elemental2.dom.DomGlobal.document; /** - * Entry point classes define onModuleLoad() + * A demo project using gwt-leaflet-d3 library. + * Entry point class defining onModuleLoad(). + *

+ * It's a simple example and the whole application logic is in the main controller. + * In the real life project parts of code would be extracted to separate components and injected here. + *

+ * MIT License + *

+ * Copyright (c) 2018 Marcin Szalomski + *

*/ public class DemoApp implements EntryPoint { diff --git a/src/main/java/pl/itrack/leafletd3/client/LeafletD3.java b/src/main/java/pl/itrack/leafletd3/client/LeafletD3.java index 4c172f4..c4854fa 100644 --- a/src/main/java/pl/itrack/leafletd3/client/LeafletD3.java +++ b/src/main/java/pl/itrack/leafletd3/client/LeafletD3.java @@ -3,10 +3,23 @@ import java.util.stream.Collectors; import java.util.stream.Stream; +/** + * The library initialization. + * Call for required JS dependencies. + * + * The gwt-leaflet-d3 is a plugin for Leaflet. + * It requires also https://github.com/gwidgets/gwty-leaflet as a main Leaflet map base. + * + *

+ * MIT License + *

+ * Copyright (c) 2018 Marcin Szalomski + *

+ */ public class LeafletD3 { public static void init(LeafletD3LibInjector.CallbackFn callbackFn) { - // TODO: provide the resources bundle together with the gwt-leaflet-d3 lib + // TODO: provide the resources bundled together with the gwt-leaflet-d3 lib LeafletD3LibInjector.injectScripts( Stream.of( "https://d3js.org/d3.v4.min.js", diff --git a/src/main/java/pl/itrack/leafletd3/client/LeafletD3LibInjector.java b/src/main/java/pl/itrack/leafletd3/client/LeafletD3LibInjector.java index 8c19aed..b5083f0 100644 --- a/src/main/java/pl/itrack/leafletd3/client/LeafletD3LibInjector.java +++ b/src/main/java/pl/itrack/leafletd3/client/LeafletD3LibInjector.java @@ -7,6 +7,15 @@ import java.util.List; +/** + * Dynamically attach to the DOM necessary resources with callback when ready + * + *

+ * MIT License + *

+ * Copyright (c) 2018 Marcin Szalomski + *

+ */ public class LeafletD3LibInjector { private static boolean processed = false; diff --git a/src/main/java/pl/itrack/leafletd3/client/wrapper/HexbinLayer.java b/src/main/java/pl/itrack/leafletd3/client/wrapper/HexbinLayer.java index a88e48c..c29e916 100644 --- a/src/main/java/pl/itrack/leafletd3/client/wrapper/HexbinLayer.java +++ b/src/main/java/pl/itrack/leafletd3/client/wrapper/HexbinLayer.java @@ -8,11 +8,21 @@ // TODO: to wrap events handling and Pings layer /** + * The GWT JsInterop wrapper for @Asymmetrik/leaflet-d3 JavaScript library. + * Provides Hexbin functionality as the one here: * https://github.com/Asymmetrik/leaflet-d3/blob/master/src/js/hexbin/HexbinLayer.js - * L is defined by the Leaflet library (see git://github.com/Leaflet/Leaflet.git for documentation). + * + *

+ * Note: The "L" is defined by the Leaflet library (see git://github.com/Leaflet/Leaflet.git for documentation). * and wrapped by https://github.com/gwidgets/gwty-leaflet . * The L is being extended to add d3-hexbin related functions. * + *

+ * MIT License + *

+ * Copyright (c) 2018 Marcin Szalomski + *

+ * * @param a data item type (eg. simply