Index: /trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java =================================================================== --- /trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java (revision 5903) @@ -390,6 +390,6 @@ /** * Tests if the areas have some intersections to join. - * @param areas - * @return + * @param areas Areas to test + * @return @{code true} if areas are joinable */ private boolean testJoin(List areas) { @@ -408,5 +408,5 @@ /** * Will join two or more overlapping areas - * @param areas - list of areas to join + * @param areas list of areas to join * @return new area formed. */ @@ -525,7 +525,6 @@ /** * Checks if tags of two given ways differ, and presents the user a dialog to solve conflicts - * @param Way First way to check - * @param Way Second Way to check - * @return boolean True if all conflicts are resolved, False if conflicts remain. + * @param polygons ways to check + * @return {@code true} if all conflicts are resolved, {@code false} if conflicts remain. */ private boolean resolveTagConflicts(List polygons) { @@ -554,6 +553,6 @@ /** * This method removes duplicate points (if any) from the input way. - * @param way the way to process - * @return true if any changes where made + * @param ways the ways to process + * @return {@code true} if any changes where made */ private boolean removeDuplicateNodes(List ways) { @@ -617,5 +616,5 @@ /** * Commits the command list with a description - * @param String The description of what the commands do + * @param description The description of what the commands do */ private void commitCommands(String description) { @@ -863,7 +862,7 @@ /** - * This method finds witch ways are outer and witch are inner. - * @param boundaryWays - * @return + * This method finds which ways are outer and which are inner. + * @param boundaries list of joined boundaries to search in + * @return outer ways */ private List findPolygons(Collection boundaries) { @@ -884,4 +883,5 @@ /** * Collects outer way and corresponding inner ways from all boundaries. + * @param level depth level * @param boundaryWays * @return the outermostWay. @@ -1073,7 +1073,7 @@ /** * Tests if way is inside other way - * @param outside - * @param inside - * @return + * @param outside outer polygon description + * @param inside inner polygon description + * @return {@code true} if inner is inside outer */ public static boolean wayInsideWay(AssembledPolygon inside, AssembledPolygon outside) { @@ -1094,6 +1094,6 @@ /** * Joins the lists of ways. - * @param Collection The list of outer ways that belong to that multigon. - * @return Way The newly created outer way + * @param polygon The list of outer ways that belong to that multigon. + * @return The newly created outer way */ private Multipolygon joinPolygon(AssembledMultipolygon polygon) throws UserCancelException { @@ -1109,6 +1109,6 @@ /** * Joins the outer ways and deletes all short ways that can't be part of a multipolygon anyway. - * @param Collection The list of outer ways that belong to that multigon. - * @return Way The newly created outer way + * @param ways The list of outer ways that belong to that multigon. + * @return The newly created outer way */ private Way joinWays(List ways) throws UserCancelException { @@ -1137,6 +1137,6 @@ /** * Joins a list of ways (using CombineWayAction and ReverseWayAction as specified in WayInPath) - * @param ArrayList The list of ways to join and reverse - * @return Way The newly created way + * @param ways The list of ways to join and reverse + * @return The newly created way */ private Way joinOrientedWays(List ways) throws UserCancelException{ @@ -1264,7 +1264,7 @@ /** * This method filters the list of relations that form the multipolygons. - * @param relations - * @param polygons - * @return + * @param relations all relations + * @param polygons polygons for filtering + * @return relations which don't form the polygons */ private List filterOwnMultipolygonRelations(Collection relations, List polygons) { @@ -1287,7 +1287,7 @@ /** * Will add own multipolygon relation to the "previously existing" relations. Fixup is done by fixRelations - * @param Collection List of already closed inner ways - * @param Way The outer way - * @param ArrayList The list of relation with roles to add own relation to + * @param inner List of already closed inner ways + * @param outer The outer way + * @return The list of relation with roles to add own relation to */ private RelationRole addOwnMultigonRelation(Collection inner, Way outer) { @@ -1308,6 +1308,6 @@ /** * Removes a given OsmPrimitive from all relations - * @param OsmPrimitive Element to remove from all relations - * @return ArrayList List of relations with roles the primitives was part of + * @param osm Element to remove from all relations + * @return List of relations with roles the primitives was part of */ private ArrayList removeFromAllRelations(OsmPrimitive osm) { @@ -1345,7 +1345,8 @@ * relations where the joined areas were in "outer" role a new relation is created instead with all * members of both. This function depends on multigon relations to be valid already, it won't fix them. - * @param ArrayList List of relations with roles the (original) ways were part of - * @param Way The newly created outer area/way - * @param relationsToDelete - set of relations to delete. + * @param rels List of relations with roles the (original) ways were part of + * @param outer The newly created outer area/way + * @param ownMultipol elements to directly add as outer + * @param relationsToDelete set of relations to delete. */ private void fixRelations(ArrayList rels, Way outer, RelationRole ownMultipol, Set relationsToDelete) { @@ -1399,5 +1400,6 @@ /** - * @param Collection The List of Ways to remove all tags from + * Remove all tags from the all the way + * @param ways The List of Ways to remove all tags from */ private void stripTags(Collection ways) { @@ -1410,5 +1412,6 @@ /** - * @param Way The Way to remove all tags from + * Remove all tags from the way + * @param x The Way to remove all tags from */ private void stripTags(Way x) { @@ -1425,5 +1428,5 @@ * Takes the last cmdsCount actions back and combines them into a single action * (for when the user wants to undo the join action) - * @param String The commit message to display + * @param message The commit message to display */ private void makeCommitsOneAction(String message) { Index: /trunk/src/org/openstreetmap/josm/command/WayNodesConflictResolverCommand.java =================================================================== --- /trunk/src/org/openstreetmap/josm/command/WayNodesConflictResolverCommand.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/command/WayNodesConflictResolverCommand.java (revision 5903) @@ -30,8 +30,6 @@ /** - * - * @param my my may - * @param their their way - * @param mergedNodeList the list of merged nodes + * @param conflict the conflict data set + * @param mergedNodeList the list of merged nodes */ @SuppressWarnings("unchecked") Index: /trunk/src/org/openstreetmap/josm/data/projection/Projection.java =================================================================== --- /trunk/src/org/openstreetmap/josm/data/projection/Projection.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/data/projection/Projection.java (revision 5903) @@ -15,5 +15,6 @@ public interface Projection { /** - * The default scale factor in east/north units per pixel ({@link #NavigatableComponent#scale})). + * The default scale factor in east/north units per pixel + * ({@link org.openstreetmap.josm.gui.NavigatableComponent#scale})). * FIXME: misnomer * @return the scale factor Index: /trunk/src/org/openstreetmap/josm/gui/MultiSplitLayout.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/MultiSplitLayout.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/MultiSplitLayout.java (revision 5903) @@ -944,5 +944,5 @@ * @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,5 +957,5 @@ * @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() { Index: /trunk/src/org/openstreetmap/josm/gui/NameFormatterHook.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/NameFormatterHook.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/NameFormatterHook.java (revision 5903) @@ -30,5 +30,5 @@ * @return The corrected format if needed, null otherwise. */ - public String checkFormat(IWay node, String defaultName); + public String checkFormat(IWay way, String defaultName); /** @@ -38,4 +38,4 @@ * @return The corrected format if needed, null otherwise. */ - public String checkFormat(IRelation node, String defaultName); + public String checkFormat(IRelation relation, String defaultName); } Index: /trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java (revision 5903) @@ -347,5 +347,5 @@ * 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,5 +396,5 @@ * 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,5 +929,5 @@ * @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,5 +985,5 @@ * * @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,7 +1035,7 @@ * @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. Index: /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ComparePairType.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ComparePairType.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ComparePairType.java (revision 5903) @@ -13,15 +13,15 @@ /** - * 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}); Index: /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ConflictResolver.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ConflictResolver.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ConflictResolver.java (revision 5903) @@ -163,4 +163,8 @@ /** * handles property change events + * @param evt the event + * @see TagMergeModel + * @see ListMergeModel + * @see PropertiesMergeModel */ public void propertyChange(PropertyChangeEvent evt) { @@ -223,7 +227,5 @@ * 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 conflict) { Index: /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ListMergeModel.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ListMergeModel.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/conflict/pair/ListMergeModel.java (revision 5903) @@ -55,10 +55,10 @@ * 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: *
    - *
  • {@link ListMergeModel#cloneEntryForMergedList(Object)} - clones an entry of type T
    • - *
  • {@link ListMergeModel#isEqualEntry(Object, Object)} - checks whether two entries are equals
    • + *
  • {@link ListMergeModel#cloneEntryForMergedList} - clones an entry of type T
    • + *
  • {@link ListMergeModel#isEqualEntry} - checks whether two entries are equals
    • *
  • {@link ListMergeModel#setValueAt(DefaultTableModel, Object, int, int)} - handles values edited in * a JTable, dispatched from {@link TableModel#setValueAt(Object, int, int)}
    • @@ -586,5 +586,4 @@ * From the point of view of the {@link JTable} it is a {@link TableModel}. * - * @param * @see ListMergeModel#getMyTableModel() * @see ListMergeModel#getTheirTableModel() Index: /trunk/src/org/openstreetmap/josm/gui/conflict/pair/nodes/NodeListMergeModel.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/conflict/pair/nodes/NodeListMergeModel.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/conflict/pair/nodes/NodeListMergeModel.java (revision 5903) @@ -52,6 +52,5 @@ * 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 Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java (revision 5903) @@ -279,7 +279,7 @@ /** - * - * @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 getAffectedPrimitives(Collection primitives) { Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/SelectionListDialog.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/SelectionListDialog.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/SelectionListDialog.java (revision 5903) @@ -464,5 +464,5 @@ * Replies the history of JOSM selections * - * @return + * @return history of JOSM selections */ public List> getSelectionHistory() { @@ -484,5 +484,5 @@ * of this model * - * @return + * @return choosen elements in the view */ public Collection getSelected() { @@ -500,5 +500,5 @@ * of this model * - * @return + * @return complete content of the view */ public Collection getAllElements() { Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManager.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManager.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManager.java (revision 5903) @@ -209,5 +209,5 @@ * in the changeset table. * - * @return + * @return changset actions panel */ protected JPanel buildChangesetTableActionPanel() { @@ -607,5 +607,6 @@ * 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 changesets) { Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetContentDownloadTask.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetContentDownloadTask.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetContentDownloadTask.java (revision 5903) @@ -87,8 +87,8 @@ * 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,7 +103,7 @@ * 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 changesetIds) throws IllegalArgumentException { Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java (revision 5903) @@ -53,5 +53,5 @@ * 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,5 +101,5 @@ /** - * 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,10 +115,10 @@ /** - * 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 dialogParent. * * 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 Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/ChangesetQueryTask.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/ChangesetQueryTask.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/ChangesetQueryTask.java (revision 5903) @@ -65,5 +65,5 @@ * 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. Index: /trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java (revision 5902) +++ /trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java (revision 5903) @@ -429,5 +429,5 @@ * builds the panel with the table displaying the currently selected primitives * - * @return + * @return panel with current selection */ protected JPanel buildSelectionTablePanel() { @@ -466,5 +466,5 @@ * build the panel with the buttons on the left * - * @return + * @return left button panel */ protected JToolBar buildLeftButtonPanel() { @@ -535,5 +535,5 @@ * build the panel with the buttons for adding or removing the current selection * - * @return + * @return control buttons panel for selection/members */ protected JToolBar buildSelectionControlButtonPanel() {