Changeset 8092 in josm for trunk/src/org/openstreetmap/josm/data/imagery

Timestamp:

2015-02-21T15:39:23+01:00 (9 years ago)

Author:

stoecker

Message:

some javadoc

File:

• trunk/src/org/openstreetmap/josm/data/imagery/ImageryInfo.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/data/imagery/ImageryInfo.java

@@ -159 +159 @@
     /** id for this imagery entry, optional at the moment */
     private String id;
+    /** URL of the imagery service */
     private String url = null;
+    /** whether this is a entry activated by default or not */
     private boolean defaultEntry = false;
+    /** The data part of HTTP cookies header in case the service requires cookies to work */
     private String cookies = null;
-    private String eulaAcceptanceRequired= null;
+    /** Whether this service requires a explicit EULA acceptance before it can be activated */
+    private String eulaAcceptanceRequired = null;
+    /** type of the imagery servics - WMS, TMS, ... */
     private ImageryType imageryType = ImageryType.WMS;
     private double pixelPerDegree = 0.0;
+    /** maximum zoom level for TMS imagery */
     private int defaultMaxZoom = 0;
+    /** minimum zoom level for TMS imagery */
     private int defaultMinZoom = 0;
+    /** display bounds of imagery, displayed in prefs and used for automatic imagery selection */
     private ImageryBounds bounds = null;
+    /** projections supported by WMS servers */
     private List<String> serverProjections;
     /** description of the imagery entry, should contain notes what type of data it is */
     private String description;
-    /** language of the description entry, "" for tr() result */
+    /** language of the description entry */
     private String langDescription;
+    /** Text of a text attribution displayed when using the imagery */
     private String attributionText;
+    /** Link behing the text attribution displayed when using the imagery */
     private String attributionLinkURL;
+    /** Image of a graphical attribution displayed when using the imagery */
     private String attributionImage;
+    /** Link behind the graphical attribution displayed when using the imagery */
     private String attributionImageURL;
+    /** Text with usage terms displayed when using the imagery */
     private String termsOfUseText;
+    /** Link behind the text with usage terms displayed when using the imagery */
     private String termsOfUseURL;
+    /** country code of the imagery (for country specific imagery) */
     private String countryCode = "";
+    /** icon used in menu */
     private String icon;
     // when adding a field, also adapt the ImageryInfo(ImageryInfo) constructor
@@ -316 +333 @@
      * @param type The entry imagery type. If null, WMS will be used as default
      * @param eulaAcceptanceRequired The EULA URL
+     * @param cookies The data part of HTTP cookies header in case the service requires cookies to work
      * @throws IllegalArgumentException if type refers to an unknown imagery type
      */
@@ -769 +787 @@
     }
 
+    /**
+     * Return the data part of HTTP cookies header in case the service requires cookies to work
+     * @return the cookie data part
+     */
     public String getCookies() {
         return this.cookies;