Changeset 5817 in josm


Ignore:
Timestamp:
2013-03-31T15:36:14+02:00 (6 years ago)
Author:
stoecker
Message:

fix javadoc

Location:
trunk/src/org/openstreetmap/josm
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2GridShift.java

    r5073 r5817  
    5858
    5959    /**
    60      * @return
     60     * Data access function for latitude value
     61     * @return latitude in seconds
    6162     */
    6263    public double getLatSeconds() {
     
    6566
    6667    /**
    67      * @return
     68     * Data access function for latitude value
     69     * @return latitude in degree
    6870     */
    6971    public double getLatDegrees() {
     
    7274
    7375    /**
    74      * @return
     76     * Data access function for latitude shift value
     77     * @return latitude shift in seconds
    7578     */
    7679    public double getLatShiftSeconds() {
     
    7982
    8083    /**
    81      * @return
     84     * Data access function for latitude shift value
     85     * @return latitude shift in degree
    8286     */
    8387    public double getLatShiftDegrees() {
     
    8690
    8791    /**
    88      * @return
     92     * Data access function for already shifted latitude value
     93     * @return shifted latitude in seconds
    8994     */
    9095    public double getShiftedLatSeconds() {
     
    9398
    9499    /**
    95      * @return
     100     * Data access function for already shifted latitude value
     101     * @return shifted latitude in degree
    96102     */
    97103    public double getShiftedLatDegrees() {
     
    100106
    101107    /**
    102      * @return
     108     * Checks whether latitude accuracy is available or not
     109     * @return <code>true</code> if latitude accuracy is available
    103110     */
    104111    public boolean isLatAccuracyAvailable() {
     
    107114
    108115    /**
    109      * @return
     116     * Data access function for latitude accuracy
     117     * @return latitude accuracy in seconds
    110118     */
    111119    public double getLatAccuracySeconds() {
     
    116124
    117125    /**
    118      * @return
     126     * Data access function for latitude accuracy
     127     * @return latitude accuracy in degree
    119128     */
    120129    public double getLatAccuracyDegrees() {
     
    125134
    126135    /**
    127      * @return
     136     * Data access function for latitude accuracy
     137     * @return latitude accuracy in meter
    128138     */
    129139    public double getLatAccuracyMetres() {
     
    134144
    135145    /**
    136      * @return
     146     * Data access function for longitude value, positive values in west direction
     147     * @return longitude in seconds
    137148     */
    138149    public double getLonPositiveWestSeconds() {
     
    141152
    142153    /**
    143      * @return
     154     * Data access function for longitude value, positive values in east direction
     155     * @return longitude in degree
    144156     */
    145157    public double getLonPositiveEastDegrees() {
     
    148160
    149161    /**
    150      * @return
     162     * Data access function for longitude shift value, positive values in west direction
     163     * @return longitude shift in seconds
    151164     */
    152165    public double getLonShiftPositiveWestSeconds() {
     
    155168
    156169    /**
    157      * @return
     170     * Data access function for longitude shift value, positive values in east direction
     171     * @return longitude shift in degree
    158172     */
    159173    public double getLonShiftPositiveEastDegrees() {
     
    162176
    163177    /**
    164      * @return
     178     * Data access function for shifted longitude value, positive values in west direction
     179     * @return shifted longitude in seconds
    165180     */
    166181    public double getShiftedLonPositiveWestSeconds() {
     
    169184
    170185    /**
    171      * @return
     186     * Data access function for shifted longitude value, positive values in east direction
     187     * @return shifted longitude in degree
    172188     */
    173189    public double getShiftedLonPositiveEastDegrees() {
     
    176192
    177193    /**
    178      * @return
     194     * Checks whether longitude accuracy is available or not
     195     * @return <code>true</code> if longitude accuracy is available
    179196     */
    180197    public boolean isLonAccuracyAvailable() {
     
    183200
    184201    /**
    185      * @return
     202     * Data access function for longitude accuracy
     203     * @return longitude accuracy in seconds
    186204     */
    187205    public double getLonAccuracySeconds() {
     
    192210
    193211    /**
    194      * @return
     212     * Data access function for longitude accuracy
     213     * @return longitude accuracy in degree
    195214     */
    196215    public double getLonAccuracyDegrees() {
     
    201220
    202221    /**
    203      * @return
     222     * Data access function for longitude accuracy
     223     * @return longitude accuracy in meter
    204224     */
    205225    public double getLonAccuracyMetres() {
     
    210230
    211231    /**
    212      * @param d
     232     * Data store function for latitude
     233     * @param d latitude value in seconds
    213234     */
    214235    public void setLatSeconds(double d) {
     
    217238
    218239    /**
    219      * @param d
     240     * Data store function for latitude
     241     * @param d latitude value in degree
    220242     */
    221243    public void setLatDegrees(double d) {
     
    224246
    225247    /**
    226      * @param b
     248     * Data store function for latitude accuracy availability
     249     * @param b availability of latitude accuracy
    227250     */
    228251    public void setLatAccuracyAvailable(boolean b) {
     
    231254
    232255    /**
    233      * @param d
     256     * Data store function for latitude accuracy
     257     * @param d latitude accuracy in seconds
    234258     */
    235259    public void setLatAccuracySeconds(double d) {
     
    238262
    239263    /**
    240      * @param d
     264     * Data store function for latitude shift
     265     * @param d latitude shift in seconds
    241266     */
    242267    public void setLatShiftSeconds(double d) {
     
    245270
    246271    /**
    247      * @param d
     272     * Data store function for longitude
     273     * @param d latitude value in seconds, west direction is positive
    248274     */
    249275    public void setLonPositiveWestSeconds(double d) {
     
    252278
    253279    /**
    254      * @param d
     280     * Data store function for longitude
     281     * @param d latitude value in degree, est direction is positive
    255282     */
    256283    public void setLonPositiveEastDegrees(double d) {
     
    259286
    260287    /**
    261      * @param b
     288     * Data store function for longitude accuracy availability
     289     * @param b availability of longitude accuracy
    262290     */
    263291    public void setLonAccuracyAvailable(boolean b) {
     
    266294
    267295    /**
    268      * @param d
     296     * Data store function for longitude accuracy
     297     * @param d longitude accuracy in seconds
    269298     */
    270299    public void setLonAccuracySeconds(double d) {
     
    273302
    274303    /**
    275      * @param d
     304     * Data store function for longitude shift value
     305     * @param d longitude shift in seconds, west direction is positive
    276306     */
    277307    public void setLonShiftPositiveWestSeconds(double d) {
     
    280310
    281311    /**
    282      * @return
     312     * Get the name of the sub grid
     313     * @return name of the sub grid
    283314     */
    284315    public String getSubGridName() {
     
    287318
    288319    /**
    289      * @param string
     320     * Set the name of the sub grid
     321     * @param string name of the sub grid
    290322     */
    291323    public void setSubGridName(String string) {
     
    295327    /**
    296328     * Make this object a copy of the supplied GridShift
    297      * @param gs
     329     * @param gs grid to copy data from
    298330     */
    299331    public void copy(NTV2GridShift gs) {
  • trunk/src/org/openstreetmap/josm/gui/ConditionalOptionPaneUtil.java

    r5724 r5817  
    3838     * The default value if the preference key is missing is true.
    3939     *
    40      * @param  the preference key
    41      * @return prefKey the preference value for the preference key "message." + <code>prefKey</code>
     40     * @param  prefKey the preference key
     41     * @return the preference value for the preference key "message." + <code>prefKey</code>
    4242     */
    4343    public static boolean getDialogShowingEnabled(String prefKey) {
     
    5959     * The default value if the preference key is missing is -1.
    6060     *
    61      * @param  the preference key
    62      * @return prefKey the preference value for the preference key "message." + <code>prefKey</code> + ".value"
     61     * @param  prefKey the preference key
     62     * @return the preference value for the preference key "message." + <code>prefKey</code> + ".value"
    6363     */
    6464    public static Integer getDialogReturnValue(String prefKey) {
Note: See TracChangeset for help on using the changeset viewer.