improved documentation

Signed-off-by: makbn <mehdi74akbarian@gmail.com>

Author: makbn

jlmap-vaadin/src/main/java/io/github/makbn/jlmap/vaadin/JLMapView.java

@@ -110,7 +110,11 @@ protected void onAttach(AttachEvent attachEvent) {
         }
     }
 
-
+    /**
+     * Generates the JavaScript function call to initialize the map.
+     *
+     * @return the JavaScript initialization string
+     */
     @SuppressWarnings("all")
     private String generateInitializeFunctionCall() {
         String call = """
@@ -141,8 +145,15 @@ private void initializeLayers() {
     }
 
     /**
-     * Called when the map is loaded successfully.
-     * This method is called from JavaScript.
+     * Called when the map is loaded successfully from JavaScript.
+     * Handles events from the client side.
+     *
+     * @param function         the function name
+     * @param jlType           the JL type
+     * @param uuid             the unique identifier
+     * @param additionalParam1 additional parameter 1
+     * @param additionalParam2 additional parameter 2
+     * @param additionalParam3 additional parameter 3
      */
     @ClientCallable
     @SuppressWarnings("unused")
@@ -152,18 +163,15 @@ public void eventHandler(String function, String jlType, String uuid, String add
     }
 
     /**
-     * Gets the JLWebEngine used by this map view.
-     *
-     * @return the JLWebEngine
+     * {@inheritDoc}
      */
     @Override
     public JLWebEngine<PendingJavaScriptResult> getJLEngine() {
         return jlWebEngine;
     }
 
     /**
-     * Adds the controller to the document.
-     * This method is called automatically when the component is attached.
+     * {@inheritDoc}
      */
     @Override
     public void addControllerToDocument() {
@@ -193,6 +201,8 @@ public void setMapViewListener(OnJLMapViewListener listener) {
     }
 
     /**
+     * Gets the GeoJson layer for this map view.
+     *
      * @return JLVaadinGeoJsonLayer
      */
     public JLVaadinGeoJsonLayer getGeoJsonLayer() {

jlmap-vaadin/src/main/java/io/github/makbn/jlmap/vaadin/engine/JLVaadinTransporter.java

@@ -8,10 +8,26 @@
 
 import java.util.concurrent.CompletableFuture;
 
+/**
+ * JLVaadinTransporter is an abstract implementation of JLTransporter for Vaadin,
+ * handling the conversion of JavaScript results to Java objects using Gson.
+ *
+ * <p>This class is used to bridge between JavaScript execution results (PendingJavaScriptResult)
+ * and Java model objects, providing a generic conversion mechanism for Vaadin-based JLMap integrations.</p>
+ *
+ * @author Matt Akbarian (@makbn)
+ */
 public abstract class JLVaadinTransporter implements JLTransporter<PendingJavaScriptResult> {
 
     Gson gson = new Gson();
 
+    /**
+     * Converts a PendingJavaScriptResult to a Java object of type M using Gson.
+     *
+     * @param result the PendingJavaScriptResult from Vaadin
+     * @param <M>    the type of the result object
+     * @return the converted Java object
+     */
     @Override
     @SneakyThrows
     public <M> M covertResult(PendingJavaScriptResult result) {

jlmap-vaadin/src/main/java/io/github/makbn/jlmap/vaadin/layer/JLVaadinControlLayer.java

@@ -17,80 +17,122 @@ public JLVaadinControlLayer(JLWebEngine<PendingJavaScriptResult> engine, JLMapCa
         super(engine, callbackHandler);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void zoomIn(int delta) {
         engine.executeScript(String.format("this.map.zoomIn(%d)", delta));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void zoomOut(int delta) {
         engine.executeScript(String.format("this.map.zoomOut(%d)", delta));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void setZoom(int level) {
         engine.executeScript(String.format("this.map.setZoom(%d)", level));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void setZoomAround(JLLatLng latLng, int zoom) {
         engine.executeScript(
                 String.format("this.map.setZoomAround(L.latLng(%f, %f), %d)",
                         latLng.getLat(), latLng.getLng(), zoom));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void fitBounds(JLBounds bounds) {
         engine.executeScript(String.format("this.map.fitBounds(%s)",
                 bounds.toString()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void fitWorld() {
         engine.executeScript("this.map.fitWorld()");
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void panTo(JLLatLng latLng) {
         engine.executeScript(String.format("this.map.panTo(L.latLng(%f, %f))",
                 latLng.getLat(), latLng.getLng()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void flyTo(JLLatLng latLng, int zoom) {
         engine.executeScript(
                 String.format("this.map.flyTo(L.latLng(%f, %f), %d)",
                         latLng.getLat(), latLng.getLng(), zoom));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void flyToBounds(JLBounds bounds) {
         engine.executeScript(String.format("this.map.flyToBounds(%s)",
                 bounds.toString()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void setMaxBounds(JLBounds bounds) {
         engine.executeScript(String.format("this.map.setMaxBounds(%s)",
                 bounds.toString()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void setMinZoom(int zoom) {
         engine.executeScript(String.format("this.map.setMinZoom(%d)", zoom));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void setMaxZoom(int zoom) {
         engine.executeScript(String.format("this.map.setMaxZoom(%d)", zoom));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void panInsideBounds(JLBounds bounds) {
         engine.executeScript(String.format("this.map.panInsideBounds(%s)",
                 bounds.toString()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void panInside(JLLatLng latLng) {
         engine.executeScript(

jlmap-vaadin/src/main/java/io/github/makbn/jlmap/vaadin/layer/JLVaadinGeoJsonLayer.java

@@ -41,25 +41,37 @@ public JLVaadinGeoJsonLayer(JLWebEngine<PendingJavaScriptResult> engine,
         this.idGenerator = new AtomicInteger();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public JLGeoJson addFromFile(@NonNull File file) throws JLException {
         String json = fromFile.load(file);
         return addGeoJson(json);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public JLGeoJson addFromUrl(@NonNull String url) throws JLException {
         String json = fromUrl.load(url);
         return addGeoJson(json);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public JLGeoJson addFromContent(@NonNull String content)
             throws JLException {
         String json = fromContent.load(content);
         return addGeoJson(json);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public boolean removeGeoJson(@NonNull String id) {
         try {
@@ -72,6 +84,12 @@ public boolean removeGeoJson(@NonNull String id) {
         }
     }
 
+    /**
+     * Adds a GeoJSON object to the map from a JSON string.
+     *
+     * @param geoJson the GeoJSON string
+     * @return the added JLGeoJson object
+     */
     private JLGeoJson addGeoJson(String geoJson) {
         String elementUniqueName = getElementUniqueName(JLGeoJson.class, idGenerator.incrementAndGet());
         JLGeoJsonObjectBuilder builder = new JLGeoJsonObjectBuilder()

jlmap-vaadin/src/main/java/io/github/makbn/jlmap/vaadin/layer/JLVaadinLayer.java

@@ -49,4 +49,12 @@ public Function<JLTransport, PendingJavaScriptResult> clientToServerTransport()
             }
         };
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }