Changeset 5891 in josm for trunk


Ignore:
Timestamp:
2013-04-20T22:41:13+02:00 (7 years ago)
Author:
stoecker
Message:

fix javadoc

Location:
trunk/src/org/openstreetmap/josm/gui
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java

    r5886 r5891  
    345345     * on every {@link ListDataEvent}.
    346346     *
    347      * @param listener  the listener
    348      * @param listSelectionModel the source emitting {@link ListDataEvent}s
     347     * @param listener the listener
     348     * @param listModel the source emitting {@link ListDataEvent}s
    349349     */
    350350    protected void adaptTo(final IEnabledStateUpdating listener, LayerListModel listModel) {
     
    15641564     * context of this {@link LayerListDialog}.
    15651565     *
    1566      * @param layer the layer
    15671566     * @return the action
    15681567     */
     
    15771576     * context of this {@link LayerListDialog}.
    15781577     *
    1579      * @param layer the layer
    15801578     * @return the action
    15811579     */
  • trunk/src/org/openstreetmap/josm/gui/dialogs/properties/TagEditHelper.java

    r5886 r5891  
    467467        * Create a focus handling adapter and apply in to the editor component of value
    468468        * autocompletion box.
    469         * @param keys Box for keys entering and autocompletion
    470         * @param values Box for values entering and autocompletion
    471469        * @param autocomplete Manager handling the autocompletion
    472470        * @param comparator Class to decide what values are offered on autocompletion
  • trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTable.java

    r5630 r5891  
    3939
    4040    /**
    41      * constructor
    42      *
    43      * @param model
    44      * @param columnModel
     41     * constructor for relation member table
     42     *
     43     * @param layer the data layer of the relation
     44     * @param model the table model
    4545     */
    4646    public MemberTable(OsmDataLayer layer, MemberTableModel model) {
  • trunk/src/org/openstreetmap/josm/gui/dialogs/validator/ValidatorTreePanel.java

    r5783 r5891  
    5454    private Set<OsmPrimitive> filter = null;
    5555
     56    /** a counter to check if tree has been rebuild */
    5657    private int updateCount;
    5758
     
    288289    /**
    289290     * Clears the current error list and adds these errors to it
    290      * @param errors The validation errors
     291     * @param newerrors The validation errors
    291292     */
    292293    public void setErrors(List<TestError> newerrors) {
     
    306307    /**
    307308     * Returns the errors of the tree
    308      * @return  the errors of the tree
     309     * @return the errors of the tree
    309310     */
    310311    public List<TestError> getErrors() {
     
    312313    }
    313314
     315    /**
     316     * Returns the filter list
     317     * @return the list of primitives used for filtering
     318     */
    314319    public Set<OsmPrimitive> getFilter() {
    315320        return filter;
    316321    }
    317322
     323    /**
     324     * Set the filter list to a set of primitives
     325     * @param filter the list of primitives used for filtering
     326     */
    318327    public void setFilter(Set<OsmPrimitive> filter) {
    319328        if (filter != null && filter.isEmpty()) {
     
    329338    /**
    330339     * Updates the current errors list
    331      * @param errors The validation errors
    332340     */
    333341    public void resetErrors() {
     
    337345
    338346    /**
    339      * Expands all tree
     347     * Expands complete tree
    340348     */
    341349    @SuppressWarnings("unchecked")
     
    359367    }
    360368
     369    /**
     370     * Returns a value to check if tree has been rebuild
     371     * @return the current counter
     372     */
    361373    public int getUpdateCount() {
    362374        return updateCount;
  • trunk/src/org/openstreetmap/josm/gui/layer/geoimage/CorrelateGpxWithImages.java

    r5886 r5891  
    10691069     * Returns a list of images that fulfill the given criteria.
    10701070     * Default setting is to return untagged images, but may be overwritten.
    1071      * @param boolean all -- returns all available images
    1072      * @param boolean noexif -- returns untagged images without EXIF-GPS coords
    1073      *                          this parameter is irrelevant if <code>all</code> is true
    1074      * @param boolean exif -- also returns images with exif-gps info
    1075      * @param boolean tagged -- also returns tagged images
    1076      * @return ArrayList<ImageEntry> matching images
     1071     * @param exif also returns images with exif-gps info
     1072     * @param tagged also returns tagged images
     1073     * @return matching images
    10771074     */
    10781075    private ArrayList<ImageEntry> getSortedImgList(boolean exif, boolean tagged) {
  • trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java

    r5875 r5891  
    310310    /**
    311311     * Move position of entries in the current list of StyleSources
    312      * @param sele The indices of styles to be moved.
     312     * @param sel The indices of styles to be moved.
    313313     * @param delta The number of lines it should move. positive int moves
    314314     *      down and negative moves up.
  • trunk/src/org/openstreetmap/josm/gui/preferences/projection/ProjectionPreference.java

    r5634 r5891  
    4747 *  - Search for official references and verify the parameter values. These
    4848 *      documents are often available in the local language only.
    49  *  - Use {@link #registerProjectionChoice()}, to make the entry known to JOSM.
     49 *  - Use {@link #registerProjectionChoice}, to make the entry known to JOSM.
    5050 *
    5151 * In case there is no EPSG code:
     
    405405     * Handles all the work related to update the projection-specific
    406406     * preferences
    407      * @param proj
     407     * @param pc the choice class representing user selection
    408408     */
    409409    private void selectedProjectionChanged(final ProjectionChoice pc) {
     
    431431    /**
    432432     * Sets up projection combobox with default values and action listener
     433     * @return the choice class for user selection
    433434     */
    434435    private ProjectionChoice setupProjectionCombo() {
  • trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java

    r5890 r5891  
    3636    }
    3737
     38    /** Ticks count used, when no other value is supplied */
    3839    public final int DEFAULT_TICKS = 10000;
    3940
     
    4445    public final int ALL_TICKS = -1;
    4546
     47    /**
     48     * Starts this progress monitor. Must be called exactly once
     49     * Ticks count is set to default value
     50     * @param title title text of the task
     51     */
    4652    void beginTask(String title);
    4753
    4854    /**
    4955     * Starts this progress monitor. Must be called exactly once
    50      * @param title
    51      * @param ticks
     56     * @param title title text of the task
     57     * @param ticks number of work units (see {@link #setTicksCount(int ticks)})
    5258     */
    5359    void beginTask(String title, int ticks);
     
    5864     * then further calls are ignored)
    5965     */
     66    void finishTask();
    6067
    61     void finishTask();
    6268    /**
    6369     * Can be used if method receive ProgressMonitor but it's not interested progress monitoring.
     
    7177
    7278    /**
    73      *
     79     * Set the total number of work units
    7480     * @param ticks Number of total work units
    7581     */
    7682    void setTicksCount(int ticks);
     83
    7784    /**
    78      *
     85     * Get the total number of work units
     86     * @return Number of total work units
     87     */
     88    int getTicksCount();
     89
     90    /**
     91     * Set the current number of work units
    7992     * @param ticks Number of work units already done
    8093     */
    8194    void setTicks(int ticks);
    8295
     96    /**
     97     * Get the current number of work units
     98     * @return Number of work units already done
     99     */
    83100    int getTicks();
    84     int getTicksCount();
    85101
    86102    /**
    87103     * Increase number of already done work units by ticks
    88      * @param ticks
     104     * @param ticks number of ticks to add
    89105     */
    90106    void worked(int ticks);
     
    92108    /**
    93109     * Subtask that will show progress running back and forth
    94      * @param title Can be null, in that case task title is not changed
     110     * @param title Can be {@code null}, in that case task title is not changed
    95111     */
    96112    void indeterminateSubTask(String title);
     113
    97114    /**
    98115     * Normal subtask
    99      * @param title Can be null, in that case task title is not changed
     116     * @param title Can be {@code null}, in that case task title is not changed
    100117     */
     118
    101119    void subTask(String title);
    102120    /**
    103121     * Shows additional text
    104122     */
     123
    105124    void setCustomText(String text);
    106125    /**
     
    118137    ProgressMonitor createSubTaskMonitor(int ticks, boolean internal);
    119138
     139    /**
     140     * Returns the state of user aborts
     141     * @return {@code true} if user aborted operation
     142     */
    120143    boolean isCanceled();
     144
     145    /**
     146     * Abort current operation, usually called when user somehow requested an abort
     147     */
    121148    void cancel();
     149
     150    /**
     151     * Add listener for user abort action
     152     * @param listener the listener for cancel operation
     153     */
    122154    void addCancelListener(CancelListener listener);
     155
     156    /**
     157     * Remove listener for user abort action
     158     * @param listener the listener for cancel operation
     159     */
    123160    void removeCancelListener(CancelListener listener);
    124161
     
    131168
    132169    /**
    133      * Should be used only by PleaseWaitRunnable. If taskId <> null then "In background" button will be shown
    134      * @param taskId
     170     * Set the task ID of the progress dialog
     171     * Should be used only by PleaseWaitRunnable. If taskId {@code <> null} then "In background" button will be shown
     172     * @param taskId the task ID
    135173     */
    136174    void setProgressTaskId(ProgressTaskId taskId);
    137175
    138176    /**
     177     * Returns the task ID of the progress dialog
    139178     * Should be used only by PleaseWaitRunnable
    140      * @param taskId
     179     * @return the task ID
    141180     */
    142181    ProgressTaskId getProgressTaskId();
    143182
    144183    /**
    145      *
     184     * Return the parent windows of progress dialog
    146185     * @return component suitable as parent for dialogs that wants to be shown in front of progress dialog
    147186     */
  • trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java

    r5266 r5891  
    4747     * for row selection and column selection.
    4848     *
    49      * To create a {@link JTable} with this model:
     49     * To create a {@link javax.swing.JTable} with this model:
    5050     * <pre>
    5151     *    TagEditorModel model = new TagEditorModel();
     
    359359
    360360    /**
    361      * initializes the model with the tags of an OSM primitive
    362      *
    363      * @param primitive the OSM primitive
     361     * Initializes the model with the tags of an OSM primitive
     362     *
     363     * @param tags the tags of an OSM primitive
    364364     */
    365365    public void initFromTags(Map<String,String> tags) {
Note: See TracChangeset for help on using the changeset viewer.