Changeset 34120 in osm for applications/editors/josm/plugins/globalsat

Timestamp:

2018-03-25T20:45:59+02:00 (7 years ago)

Author:

stoecker

Message:

Fix javadoc

Location:

applications/editors/josm/plugins/globalsat/src/org

Files:

• kaintoch/gps/globalsat/dg100/ByteHelper.java (modified) (6 diffs)
• kaintoch/gps/globalsat/dg100/GpsRec.java (modified) (15 diffs)
• openstreetmap/josm/plugins/globalsat/GlobalsatDg100.java (modified) (1 diff)

applications/editors/josm/plugins/globalsat/src/org/kaintoch/gps/globalsat/dg100/ByteHelper.java

@@ -13 +13 @@
 
     /**
-     *
-     * @param src
-     * @param startS
-     * @param len
-     * @param dest
-     * @param startD
-     * @return
+     * Copy one byte array into another
+     * @param src the array to copy data from
+     * @param startS start index in source array
+     * @param len number of entries to copy
+     * @param dest the array to copy into
+     * @param startD start index in target array
+     * @return the index pointer behind the last target array copied
      */
     public static int copyByteArr2ByteArr(byte src[], int startS, int len, byte dest[], int startD)
@@ -33 +33 @@
 
     /**
-     *
-     * @param byt
-     * @return
+     * Convert byte to unsigned integer
+     * @param byt byte value to convert
+     * @return unsigned integer
      */
     public static int byte2IntUnsigned(byte byt)
@@ -43 +43 @@
 
     /**
-     *
-     * @param nibble
+     * Convert 4 bit into hexadecimal character
+     * @param nibble value to convert (only last 4 bit used)
+     * @return character in range of 0 to F
      */
     private static char nibble2Char(int nibble)
@@ -73 +74 @@
 
     /**
-     *
-     * @return
+     * Convert byte to unsigned hexadecimal string
+     * @param byt byte value to convert
+     * @return 2 character string representing the last 8 bit
      */
     public static String byte2StringUnsigned(byte byt)
@@ -87 +89 @@
 
     /**
-     *
-     * @param byt
+     * Convert byte array to unsigned hexadecimal string
+     * @param byt array of bytes to convert
+     * @return hexadecimal string representing the byte array
      */
     public static String byteArray2String(byte byt[])
@@ -96 +99 @@
 
     /**
-     *
-     * @param byt
-     * @param cnt
+     * Convert byte array to unsigned hexadecimal string
+     * @param byt array of bytes to convert
+     * @param cnt number of entries to convert
+     * @return hexadecimal string representing the byte array
      */
     public static String byteArray2String(byte byt[], int cnt)

applications/editors/josm/plugins/globalsat/src/org/kaintoch/gps/globalsat/dg100/GpsRec.java

@@ -114 +114 @@
     /**
      * Shows wether this is a valid GPS record.
-     * @return true if GPS record is valid; otherwise false.
+     * @return <code>true</code> if GPS record is valid; otherwise <code>false</code>.
      */
     public boolean isValid()
@@ -157 +157 @@
 
     /**
-     * @return Returns the dg100Latitude.
+     * Get latitude value
+     * @return Returns the dg100Latitude value.
      */
     public int getDg100Latitude()
@@ -255 +256 @@
     /**
      * Gets dg100Date and time as a String in given format.
-     * @param dateTimeFormat
-     * @return
+     * @param dateTimeFormat format string for date and time
+     * @return formated date and time
      */
     private String getStringDateTime(String dateTimeFormat)
@@ -271 +272 @@
 
     /**
+     * Get the altitude value
      * @return Returns the dg100Altitude.
      */
@@ -279 +281 @@
 
     /**
-     * @param dg100Altitude The dg100Altitude to set.
+     * Set the altitude value
+     * @param altitude The dg100Altitude to set.
      */
     private void setDg100Altitude(int altitude)
@@ -287 +290 @@
 
     /**
+     * Get date information
      * @return Returns the dg100Date.
      */
@@ -295 +299 @@
 
     /**
-     * @param dg100Date The dg100Date to set.
+     * Set date information
+     * @param date The dg100Date to set.
      */
     private void setDg100Date(int date)
@@ -304 +309 @@
 
     /**
-     * @return
+     * calculate date and time from individual components
      */
     private void calcDateTime()
@@ -319 +324 @@
 
     /**
+     * Get longitude value
      * @return Returns the dg100Longitude.
      */
@@ -327 +333 @@
 
     /**
-     * @param dg100Longitude The dg100Longitude to set.
+     * Set longitude value
+     * @param longitude The dg100Longitude to set.
      */
     private void setDg100Longitude(int longitude)
@@ -335 +342 @@
 
     /**
+     * Get speed value
      * @return Returns the dg100Speed.
      */
@@ -343 +351 @@
 
     /**
-     * @param dg100Speed The dg100Speed to set.
+     * Set speed value
+     * @param speed The dg100Speed to set.
      */
     private void setDg100Speed(int speed)
@@ -351 +360 @@
 
     /**
+     * Get timezone value
      * @return Returns the dg100TimeZ.
      */
@@ -359 +369 @@
 
     /**
-     * @param dg100TimeZ The dg100TimeZ to set.
+     * Set timezone value
+     * @param timeZ The dg100TimeZ to set.
      */
     private void setDg100TimeZ(int timeZ)
@@ -368 +379 @@
 
     /**
-     * @param dg100Latitude The dg100Latitude to set.
+     * Set latitude value
+     * @param latitude The dg100Latitude to set.
      */
     private void setDg100Latitude(int latitude)

applications/editors/josm/plugins/globalsat/src/org/openstreetmap/josm/plugins/globalsat/GlobalsatDg100.java

@@ -133 +133 @@
 
     /**
-     * Export DG-100's complete data to a GPX file.
-     * @param port DG-100 is connected to port.
+     * Import DG-100's complete data
+     * @param progressMonitor user progress interface 
      */
     public GpxData readData(ProgressMonitor progressMonitor) throws ConnectionException {