Ignore:
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:
3 edited

Legend:

Unmodified
Added
Removed

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

    r13497 r34120  
    1313
    1414    /**
    15      *
    16      * @param src
    17      * @param startS
    18      * @param len
    19      * @param dest
    20      * @param startD
    21      * @return
     15     * Copy one byte array into another
     16     * @param src the array to copy data from
     17     * @param startS start index in source array
     18     * @param len number of entries to copy
     19     * @param dest the array to copy into
     20     * @param startD start index in target array
     21     * @return the index pointer behind the last target array copied
    2222     */
    2323    public static int copyByteArr2ByteArr(byte src[], int startS, int len, byte dest[], int startD)
    … …  
    3333
    3434    /**
    35      *
    36      * @param byt
    37      * @return
     35     * Convert byte to unsigned integer
     36     * @param byt byte value to convert
     37     * @return unsigned integer
    3838     */
    3939    public static int byte2IntUnsigned(byte byt)
    … …  
    4343
    4444    /**
    45      *
    46      * @param nibble
     45     * Convert 4 bit into hexadecimal character
     46     * @param nibble value to convert (only last 4 bit used)
     47     * @return character in range of 0 to F
    4748     */
    4849    private static char nibble2Char(int nibble)
    … …  
    7374
    7475    /**
    75      *
    76      * @return
     76     * Convert byte to unsigned hexadecimal string
     77     * @param byt byte value to convert
     78     * @return 2 character string representing the last 8 bit
    7779     */
    7880    public static String byte2StringUnsigned(byte byt)
    … …  
    8789
    8890    /**
    89      *
    90      * @param byt
     91     * Convert byte array to unsigned hexadecimal string
     92     * @param byt array of bytes to convert
     93     * @return hexadecimal string representing the byte array
    9194     */
    9295    public static String byteArray2String(byte byt[])
    … …  
    9699
    97100    /**
    98      *
    99      * @param byt
    100      * @param cnt
     101     * Convert byte array to unsigned hexadecimal string
     102     * @param byt array of bytes to convert
     103     * @param cnt number of entries to convert
     104     * @return hexadecimal string representing the byte array
    101105     */
    102106    public static String byteArray2String(byte byt[], int cnt)

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

    r33854 r34120  
    114114    /**
    115115     * Shows wether this is a valid GPS record.
    116      * @return true if GPS record is valid; otherwise false.
     116     * @return <code>true</code> if GPS record is valid; otherwise <code>false</code>.
    117117     */
    118118    public boolean isValid()
    … …  
    157157
    158158    /**
    159      * @return Returns the dg100Latitude.
     159     * Get latitude value
     160     * @return Returns the dg100Latitude value.
    160161     */
    161162    public int getDg100Latitude()
    … …  
    255256    /**
    256257     * Gets dg100Date and time as a String in given format.
    257      * @param dateTimeFormat
    258      * @return
     258     * @param dateTimeFormat format string for date and time
     259     * @return formated date and time
    259260     */
    260261    private String getStringDateTime(String dateTimeFormat)
    … …  
    271272
    272273    /**
     274     * Get the altitude value
    273275     * @return Returns the dg100Altitude.
    274276     */
    … …  
    279281
    280282    /**
    281      * @param dg100Altitude The dg100Altitude to set.
     283     * Set the altitude value
     284     * @param altitude The dg100Altitude to set.
    282285     */
    283286    private void setDg100Altitude(int altitude)
    … …  
    287290
    288291    /**
     292     * Get date information
    289293     * @return Returns the dg100Date.
    290294     */
    … …  
    295299
    296300    /**
    297      * @param dg100Date The dg100Date to set.
     301     * Set date information
     302     * @param date The dg100Date to set.
    298303     */
    299304    private void setDg100Date(int date)
    … …  
    304309
    305310    /**
    306      * @return
     311     * calculate date and time from individual components
    307312     */
    308313    private void calcDateTime()
    … …  
    319324
    320325    /**
     326     * Get longitude value
    321327     * @return Returns the dg100Longitude.
    322328     */
    … …  
    327333
    328334    /**
    329      * @param dg100Longitude The dg100Longitude to set.
     335     * Set longitude value
     336     * @param longitude The dg100Longitude to set.
    330337     */
    331338    private void setDg100Longitude(int longitude)
    … …  
    335342
    336343    /**
     344     * Get speed value
    337345     * @return Returns the dg100Speed.
    338346     */
    … …  
    343351
    344352    /**
    345      * @param dg100Speed The dg100Speed to set.
     353     * Set speed value
     354     * @param speed The dg100Speed to set.
    346355     */
    347356    private void setDg100Speed(int speed)
    … …  
    351360
    352361    /**
     362     * Get timezone value
    353363     * @return Returns the dg100TimeZ.
    354364     */
    … …  
    359369
    360370    /**
    361      * @param dg100TimeZ The dg100TimeZ to set.
     371     * Set timezone value
     372     * @param timeZ The dg100TimeZ to set.
    362373     */
    363374    private void setDg100TimeZ(int timeZ)
    … …  
    368379
    369380    /**
    370      * @param dg100Latitude The dg100Latitude to set.
     381     * Set latitude value
     382     * @param latitude The dg100Latitude to set.
    371383     */
    372384    private void setDg100Latitude(int latitude)

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

    r33854 r34120  
    133133
    134134    /**
    135      * Export DG-100's complete data to a GPX file.
    136      * @param port DG-100 is connected to port.
     135     * Import DG-100's complete data
     136     * @param progressMonitor user progress interface
    137137     */
    138138    public GpxData readData(ProgressMonitor progressMonitor) throws ConnectionException {
Note: See TracChangeset for help on using the changeset viewer.