Changeset 5903 in josm for trunk/src/org/openstreetmap/josm/gui

Timestamp:

2013-04-25T17:57:04+02:00 (11 years ago)

Author:

stoecker

Message:

fix javadoc

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• MultiSplitLayout.java (modified) (2 diffs)
• NameFormatterHook.java (modified) (2 diffs)
• NavigatableComponent.java (modified) (5 diffs)
• conflict/pair/ComparePairType.java (modified) (1 diff)
• conflict/pair/ConflictResolver.java (modified) (2 diffs)
• conflict/pair/ListMergeModel.java (modified) (2 diffs)
• conflict/pair/nodes/NodeListMergeModel.java (modified) (1 diff)
• dialogs/FilterDialog.java (modified) (1 diff)
• dialogs/SelectionListDialog.java (modified) (3 diffs)
• dialogs/changeset/ChangesetCacheManager.java (modified) (2 diffs)
• dialogs/changeset/ChangesetContentDownloadTask.java (modified) (2 diffs)
• dialogs/changeset/ChangesetHeaderDownloadTask.java (modified) (3 diffs)
• dialogs/changeset/query/ChangesetQueryTask.java (modified) (1 diff)
• dialogs/relation/GenericRelationEditor.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/MultiSplitLayout.java

@@ -944 +944 @@
          * @return the Node that comes after this one in the parent's list of children.
          * @see #previousSibling
-         * @see #getParent
+         * @see #parent_get
          */
         public Node nextSibling() {
@@ -957 +957 @@
          * @return the Node that comes before this one in the parent's list of children.
          * @see #nextSibling
-         * @see #getParent
+         * @see #parent_get
          */
         public Node previousSibling() {

trunk/src/org/openstreetmap/josm/gui/NameFormatterHook.java

@@ -30 +30 @@
      * @return The corrected format if needed, null otherwise.
      */
-    public String checkFormat(IWay node, String defaultName);
+    public String checkFormat(IWay way, String defaultName);
 
     /**
@@ -38 +38 @@
      * @return The corrected format if needed, null otherwise.
      */
-    public String checkFormat(IRelation node, String defaultName);
+    public String checkFormat(IRelation relation, String defaultName);
 }

trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java

@@ -347 +347 @@
      * Zoom to the given coordinate.
      * @param newCenter The center x-value (easting) to zoom to.
-     * @param scale The scale to use.
+     * @param newScale The scale to use.
      */
     public void zoomTo(EastNorth newCenter, double newScale) {
@@ -396 +396 @@
      * Zoom to the given coordinate without adding to the zoom undo buffer.
      * @param newCenter The center x-value (easting) to zoom to.
-     * @param scale The scale to use.
+     * @param newScale The scale to use.
      */
     private void zoomNoUndoTo(EastNorth newCenter, double newScale) {
@@ -929 +929 @@
      * @return The nearest way to point p,
      *      prefer a selected way if there are multiple nearest.
-     * @see #getNearestWaySegment(Point, Collection, Predicate)
+     * @see #getNearestWaySegment(Point, Predicate)
      *
      * @param p the point for which to search the nearest segment.
@@ -985 +985 @@
      *
      * @return Primitives nearest to the given screen point.
-     * @see #getNearests(Point, Collection, Predicate)
+     * @see #getNearestNodesOrWays(Point, Collection, Predicate)
      *
      * @param p The point on screen.
@@ -1035 +1035 @@
      * @return A primitive within snap-distance to point p,
      *      that is chosen by the algorithm described.
-     * @see getNearestNode(Point, Predicate)
-     * @see getNearestNodesImpl(Point, Predicate)
-     * @see getNearestWay(Point, Predicate)
+     * @see #getNearestNode(Point, Predicate)
+     * @see #getNearestNodesImpl(Point, Predicate)
+     * @see #getNearestWay(Point, Predicate)
      *
      * @param p The point on screen.

trunk/src/org/openstreetmap/josm/gui/conflict/pair/ComparePairType.java

@@ -13 +13 @@
 
     /**
-     * compare my version of an {@link OsmPrimitive} with their version
+     * compare my version of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive} with their version
      */
     MY_WITH_THEIR (tr("My with Their"), new ListRole[] {MY_ENTRIES, THEIR_ENTRIES}),
 
     /**
-     * compare my version of an {@link OsmPrimitive} with the merged version
+     * compare my version of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive} with the merged version
      */
     MY_WITH_MERGED (tr("My with Merged"),  new ListRole[] {MY_ENTRIES, MERGED_ENTRIES}),
 
     /**
-     * compare their version of an {@link OsmPrimitive} with the merged veresion
+     * compare their version of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive} with the merged veresion
      */
     THEIR_WITH_MERGED(tr("Their with Merged"),  new ListRole[] {THEIR_ENTRIES, MERGED_ENTRIES});

trunk/src/org/openstreetmap/josm/gui/conflict/pair/ConflictResolver.java

@@ -163 +163 @@
     /**
      * handles property change events
+     * @param evt the event
+     * @see TagMergeModel
+     * @see ListMergeModel
+     * @see PropertiesMergeModel
      */
     public void propertyChange(PropertyChangeEvent evt) {
@@ -223 +227 @@
      * populates the conflict resolver with the conflicts between my and their
      *
-     * @param my   my primitive (i.e. the primitive in the local dataset)
-     * @param their their primitive (i.e. the primitive in the server dataset)
-     *
+     * @param conflict the conflict data set
      */
     public void populate(Conflict<? extends OsmPrimitive> conflict) {

trunk/src/org/openstreetmap/josm/gui/conflict/pair/ListMergeModel.java

@@ -55 +55 @@
  * A ListMergeModel can be ''frozen''. If it's frozen, it doesn't accept additional merge
  * decisions. {@link PropertyChangeListener}s can register for property value changes of
- * {@link #PROP_FROZEN}.
+ * {@link #FROZEN_PROP}.
  *
  * ListMergeModel is an abstract class. Three methods have to be implemented by subclasses:
  * <ul>
- *   <li>{@link ListMergeModel#cloneEntryForMergedList(Object)} - clones an entry of type T</li>
- *   <li>{@link ListMergeModel#isEqualEntry(Object, Object)} - checks whether two entries are equals </li>
+ *   <li>{@link ListMergeModel#cloneEntryForMergedList} - clones an entry of type T</li>
+ *   <li>{@link ListMergeModel#isEqualEntry} - checks whether two entries are equals </li>
  *   <li>{@link ListMergeModel#setValueAt(DefaultTableModel, Object, int, int)} - handles values edited in
  *     a JTable, dispatched from {@link TableModel#setValueAt(Object, int, int)} </li>
@@ -586 +586 @@
      * From the point of view of the {@link JTable} it is a {@link TableModel}.
      *
-     * @param <T>
      * @see ListMergeModel#getMyTableModel()
      * @see ListMergeModel#getTheirTableModel()

trunk/src/org/openstreetmap/josm/gui/conflict/pair/nodes/NodeListMergeModel.java

@@ -52 +52 @@
      * Builds the command to resolve conflicts in the node list of a way
      *
-     * @param my  my way. Must not be null.
-     * @param their  their way. Must not be null
+     * @param conflict the conflict data set
      * @return the command
      * @exception IllegalStateException thrown, if the merge is not yet frozen

trunk/src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java

@@ -279 +279 @@
 
     /**
-     *
-     * @param primitive
-     * @return List of primitives whose filtering can be affected by change in primitive
+     * Returns the list of primitives whose filtering can be affected by change in primitive
+     * @param primitives list of primitives to check
+     * @return List of primitives whose filtering can be affected by change in source primitives
      */
     private Collection<OsmPrimitive> getAffectedPrimitives(Collection<? extends OsmPrimitive> primitives) {

trunk/src/org/openstreetmap/josm/gui/dialogs/SelectionListDialog.java

@@ -464 +464 @@
          * Replies the history of JOSM selections
          *
-         * @return
+         * @return history of JOSM selections
          */
         public List<Collection<? extends OsmPrimitive>> getSelectionHistory() {
@@ -484 +484 @@
          * of this model
          *
-         * @return
+         * @return choosen elements in the view
          */
         public Collection<OsmPrimitive> getSelected() {
@@ -500 +500 @@
          * of this model
          *
-         * @return
+         * @return complete content of the view
          */
         public Collection<OsmPrimitive> getAllElements() {

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManager.java

@@ -209 +209 @@
      * in the changeset table.
      *
-     * @return
+     * @return changset actions panel
      */
     protected JPanel buildChangesetTableActionPanel() {
@@ -607 +607 @@
      * respective changesets are already present in the local changeset cache.
      *
-     * @param ids the collection of changesets. If null, the selection is cleared.
+     * @param changesets the collection of changesets. If {@code null}, the
+     * selection is cleared.
      */
     public void setSelectedChangesets(Collection<Changeset> changesets) {

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetContentDownloadTask.java

@@ -87 +87 @@
      * Creates a download task for a single changeset
      *
-     * @param parent the parent component for the {@link PleaseWaitDialog}. Must not be null.
-     * @param changesetId the changeset id. >0 required.
-     * @throws IllegalArgumentException thrown if changesetId <= 0
-     * @throws IllegalArgumentException thrown if parent is null
+     * @param parent the parent component for the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}. Must not be {@code null}.
+     * @param changesetId the changeset id. {@code >0} required.
+     * @throws IllegalArgumentException thrown if {@code changesetId <= 0}
+     * @throws IllegalArgumentException thrown if parent is {@code null}
      */
     public ChangesetContentDownloadTask(Component parent, int changesetId) throws IllegalArgumentException{
@@ -103 +103 @@
      * the collection are sillently discarded.
      *
-     * @param parent the parent component for the {@link PleaseWaitDialog}. Must not be null.
-     * @param changesetIds the changeset ids. Empty collection assumed, if null.
-     * @throws IllegalArgumentException thrown if parent is null
+     * @param parent the parent component for the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}. Must not be {@code null}.
+     * @param changesetIds the changeset ids. Empty collection assumed, if {@code null}.
+     * @throws IllegalArgumentException thrown if parent is {@code null}
      */
     public ChangesetContentDownloadTask(Component parent, Collection<Integer> changesetIds) throws IllegalArgumentException {

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java

@@ -53 +53 @@
      * Ignores null values and changesets with {@link Changeset#isNew()} == true.
      *
-     * @param parent the parent component relative to which the {@link PleaseWaitDialog} is displayed.
+     * @param parent the parent component relative to which the {@link org.openstreetmap.josm.gui.PleaseWaitDialog} is displayed.
      * Must not be null.
      * @param changesets the collection of changesets. Assumes an empty collection if null.
@@ -101 +101 @@
 
     /**
-     * Creates the download task for a collection of changeset ids. Uses a {@link PleaseWaitDialog}
+     * Creates the download task for a collection of changeset ids. Uses a {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
      * whose parent is {@link Main#parent}.
      *
@@ -115 +115 @@
 
     /**
-     * Creates the download task for a collection of changeset ids. Uses a {@link PleaseWaitDialog}
+     * Creates the download task for a collection of changeset ids. Uses a {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
      * whose parent is the parent window of <code>dialogParent</code>.
      *
      * Null ids or or ids <= 0 in the id collection are ignored.
      *
-     * @param dialogParent the parent reference component for the {@link PleaseWaitDialog}. Must not be null.
+     * @param dialogParent the parent reference component for the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}. Must not be null.
      * @param ids the collection of ids. Empty collection assumed if null.
      * @throws IllegalArgumentException thrown if dialogParent is null

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/ChangesetQueryTask.java

@@ -65 +65 @@
      * Creates the task.
      *
-     * @param parent the parent component relative to which the {@link PleaseWaitDialog} is displayed.
+     * @param parent the parent component relative to which the {@link org.openstreetmap.josm.gui.PleaseWaitDialog} is displayed.
      * Must not be null.
      * @param query the query to submit to the OSM server. Must not be null.

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java

@@ -429 +429 @@
      * builds the panel with the table displaying the currently selected primitives
      *
-     * @return
+     * @return panel with current selection
      */
     protected JPanel buildSelectionTablePanel() {
@@ -466 +466 @@
      * build the panel with the buttons on the left
      *
-     * @return
+     * @return left button panel
      */
     protected JToolBar buildLeftButtonPanel() {
@@ -535 +535 @@
      * build the panel with the buttons for adding or removing the current selection
      *
-     * @return
+     * @return control buttons panel for selection/members
      */
     protected JToolBar buildSelectionControlButtonPanel() {