Updated docs

Author: AB-xdev

CHANGELOG.md

@@ -2,7 +2,7 @@
 ⚠️<i>This release contains breaking changes</i>
 
 * The complete API got reworked and now has the [same structure as Leaflet](https://leafletjs.com/reference.html).
-* Implemented a lot of new Leaflet APIs - Currently around 90% of the Leaflet API are implemented. These include the most useful bits:
+* Added lots of new Leaflet APIs - currently around 90% of the Leaflet API are implemented. These include the most useful bits:
   * GeoLocation
   * A lot of new methods for Map
   * Tooltips & Popups
@@ -11,9 +11,9 @@
   * Controls for Scale, Layers, ...
   * and much more
 * Abstracted the elements similar to how this is done inside Leaflet itself so that they can easily be extended
-* The API only supports sending instructions to the client. Retrieving client side data is not supported as it can't be data integrity guaranteed (data on client can be modified).
+* The API only supports sending instructions to the client. Retrieving client side data is not supported as data integrity can't be guaranteed (client-side data can be modified by users).
   * Event listeners can still be registered but this needs to be done manually. A example is available in the demo.
-* All Leaflet elements are now tracked on the client and on the server and can therefore be modified/reused.
+* All Leaflet elements are now tracked on the client and on the server and can therefore be modified/reused (using ``LComponentManagementRegistry``).
   * Before it was only possible to create an element and then send it to the client
   * However keep in mind when creating a lot of elements that you may have to free up memory on the client (manually)
 * Integrated default Leaflet resources

vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/LeafletView.java

@@ -368,6 +368,9 @@ private void addComplexPolygonDemo()
 		));
 	}
 
+	/**
+	 * Used for testing if memory on the client side is freed up correctly when handling a lot of components
+	 */
 	// S5413 - Yes it's used correctly
 	// S2245 - This is a reproducible demo
 	// S1215 - This is a memory test and we don't rely on random GC collects
@@ -377,8 +380,8 @@ private void addMemoryTestDemo()
 		final AtomicBoolean abort = new AtomicBoolean(false);
 
 		this.hlButtons.add(this.createToggleButton(
-			"Start memory test",
-			"Stop memory test",
+			"Start browser memory test",
+			"Stop browser memory test",
 			() -> {
 				this.map.setView(new LLatLng(this.reg, 0, 0), 12);
 

vaadin-maps-leaflet-flow/src/main/java/software/xdev/vaadin/maps/leaflet/basictypes/LDivIcon.java

@@ -19,7 +19,7 @@
 
 
 /**
- * <a href="https://leafletjs.com/reference.html#divicon">Documentation</a>
+ * @see <a href="https://leafletjs.com/reference.html#divicon">Leaflet docs</a>
  */
 public class LDivIcon extends LIcon
 {

vaadin-maps-leaflet-flow/src/main/java/software/xdev/vaadin/maps/leaflet/basictypes/LDivIconOptions.java

@@ -16,7 +16,7 @@
 package software.xdev.vaadin.maps.leaflet.basictypes;
 
 /**
- * <a href="https://leafletjs.com/reference.html#divicon">Documentation</a>
+ * @see <a href="https://leafletjs.com/reference.html#divicon">Leaflet docs</a>
  */
 public class LDivIconOptions extends LAbstractIconOptions<LDivIconOptions>
 {

vaadin-maps-leaflet-flow/src/main/java/software/xdev/vaadin/maps/leaflet/basictypes/LIcon.java

@@ -19,6 +19,9 @@
 import software.xdev.vaadin.maps.leaflet.registry.LComponentManagementRegistry;
 
 
+/**
+ * @see <a href="https://leafletjs.com/reference.html#icon">Leaflet docs</a>
+ */
 public class LIcon extends LBaseComponent<LIcon>
 {
 	protected LIcon(

vaadin-maps-leaflet-flow/src/main/java/software/xdev/vaadin/maps/leaflet/basictypes/LIconOptions.java

@@ -16,7 +16,7 @@
 package software.xdev.vaadin.maps.leaflet.basictypes;
 
 /**
- * <a href="https://leafletjs.com/reference.html#icon">Documentation</a>
+ * @see <a href="https://leafletjs.com/reference.html#icon">Leaflet docs</a>
  */
 public class LIconOptions extends LAbstractIconOptions<LIconOptions>
 {

vaadin-maps-leaflet-flow/src/main/java/software/xdev/vaadin/maps/leaflet/registry/LComponentManagementRegistry.java

@@ -23,6 +23,11 @@
 import software.xdev.vaadin.maps.leaflet.base.LComponentOptions;
 
 
+/**
+ * Used for tracking components (on the client).
+ * <p/>
+ * Links components from server (Java) and client (JS) so that they can be reused and/or manipulated after creation.
+ */
 public interface LComponentManagementRegistry
 {
 	// region Write Options