@@ -22,6 +22,7 @@ Project Source Code: https://github.com/makbn/java_leaflet
2222- ** Unified API** : Consistent interface across different UI frameworks
2323- ** Enhanced Modularity** : Better separation of concerns and extensibility
2424- ** Modern Java** : Full Java 17+ and JPMS support
25+ - ** Comprehensive Documentation** : Complete JavaDoc coverage with usage examples and technical details
2526
2627## 🏗️ Project Structure
2728
@@ -73,7 +74,6 @@ refer to the [Feature Comparison Table](Feature.md).
7374Add the JavaFX dependency to your ` pom.xml ` :
7475
7576``` xml
76-
7777<dependency >
7878 <groupId >io.github.makbn</groupId >
7979 <artifactId >jlmap-fx</artifactId >
@@ -86,7 +86,6 @@ Add the JavaFX dependency to your `pom.xml`:
8686Add the Vaadin dependency to your ` pom.xml ` :
8787
8888``` xml
89-
9089<dependency >
9190 <groupId >io.github.makbn</groupId >
9291 <artifactId >jlmap-vaadin</artifactId >
@@ -168,74 +167,50 @@ public class VaadinMapExample extends VerticalLayout {
168167
169168### Map Control
170169
171- ``` jshelllanguage
172- // Change the current coordinate
173- map.setView(JLLatLng.builder()
174- .lng(10)
175- .lat(10)
176- .build());
177-
178- // Map zoom functionalities
179- map.getControlLayer().
180- setZoom(5);
181-
182- map.getControlLayer().zoomIn(2);
183- map.
184-
185- getControlLayer().
186-
187- zoomOut(1);
170+ ``` java
171+ // Change the current coordinate
172+ map. setView(JLLatLng . builder()
173+ .lng(10 )
174+ .lat(10 )
175+ .build());
176+
177+ // Map zoom functionalities
178+ map. getControlLayer(). setZoom(5 );
179+ map. getControlLayer(). zoomIn(2 );
180+ map. getControlLayer(). zoomOut(1 );
188181```
189182
190183### Adding Markers
191184
192185``` java
193186// Add a marker to the UI layer
194187JLMarker marker = map. getUiLayer()
195- .addMarker(JLLatLng . builder()
196- .lat(35.63 )
197- .lng(51.45 )
198- .build(), " Tehran" , true );
188+ .addMarker(JLLatLng . builder()
189+ .lat(35.63 )
190+ .lng(51.45 )
191+ .build(), " Tehran" , true );
199192
200193// Add event listeners
201- marker.
202-
203- setOnActionListener((jlMarker, event) - > {
204- if (event instanceof ClickEvent ){
205- System . out.
206-
207- println(" Marker clicked: " + jlMarker);
194+ marker. setOnActionListener((jlMarker, event) - > {
195+ if (event instanceof ClickEvent ) {
196+ System . out. println(" Marker clicked: " + jlMarker);
208197 }
209- });
198+ });
210199```
211200
212201### Adding Shapes
213202
214203``` java
215204// Add a circle
216205map. getVectorLayer()
217- .
218-
219- addCircle(JLLatLng . builder()
220- .
221-
222- lat(35.63 )
223- .
224-
225- lng(51.45 )
226- .
227-
228- build(),
206+ .addCircle(JLLatLng . builder()
207+ .lat(35.63 )
208+ .lng(51.45 )
209+ .build(),
229210 30000 ,
230- JLOptions .
231-
232- builder()
233- .
234-
235- color(JLColor . BLACK )
236- .
237-
238- build());
211+ JLOptions . builder()
212+ .color(JLColor . BLACK )
213+ .build());
239214```
240215
241216### Layer Management
@@ -351,7 +326,6 @@ v2.0.0
351326** Before (v1.x):**
352327
353328``` xml
354-
355329<dependency >
356330 <groupId >io.github.makbn</groupId >
357331 <artifactId >jlmap</artifactId >
@@ -369,11 +343,11 @@ v2.0.0
369343 <version >2.0.0</version >
370344</dependency >
371345
372- <!-- For Vaadin -->
346+ <!-- For Vaadin -->
373347<dependency >
374- <groupId >io.github.makbn</groupId >
375- <artifactId >jlmap-vaadin</artifactId >
376- <version >2.0.0</version >
348+ <groupId >io.github.makbn</groupId >
349+ <artifactId >jlmap-vaadin</artifactId >
350+ <version >2.0.0</version >
377351</dependency >
378352```
379353
@@ -424,6 +398,7 @@ the [LICENSE](LICENSE) file for details.
424398- ** Enhancement** : Unified API across different UI frameworks & Improved Fluent API
425399- ** Enhancement** : Improved separation of concerns
426400- ** Enhancement** : Added comprehensive demo applications
401+ - ** Enhancement** : Complete JavaDoc documentation with usage examples and technical details
427402- ** Fix** : Resolved module system compatibility issues
428403
429404### Version 1.9.5
0 commit comments