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


Ignore:
Timestamp:
2013-04-25T17:57:04+02:00 (7 years ago)
Author:
stoecker
Message:

fix javadoc

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

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java

    r5889 r5903  
    390390    /**
    391391     * Tests if the areas have some intersections to join.
    392      * @param areas
    393      * @return
     392     * @param areas Areas to test
     393     * @return @{code true} if areas are joinable
    394394     */
    395395    private boolean testJoin(List<Multipolygon> areas) {
     
    408408    /**
    409409     * Will join two or more overlapping areas
    410      * @param areas - list of areas to join
     410     * @param areas list of areas to join
    411411     * @return new area formed.
    412412     */
     
    525525    /**
    526526     * Checks if tags of two given ways differ, and presents the user a dialog to solve conflicts
    527      * @param Way First way to check
    528      * @param Way Second Way to check
    529      * @return boolean True if all conflicts are resolved, False if conflicts remain.
     527     * @param polygons ways to check
     528     * @return {@code true} if all conflicts are resolved, {@code false} if conflicts remain.
    530529     */
    531530    private boolean resolveTagConflicts(List<Multipolygon> polygons) {
     
    554553    /**
    555554     * This method removes duplicate points (if any) from the input way.
    556      * @param way the way to process
    557      * @return true if any changes where made
     555     * @param ways the ways to process
     556     * @return {@code true} if any changes where made
    558557     */
    559558    private boolean removeDuplicateNodes(List<Way> ways) {
     
    617616    /**
    618617     * Commits the command list with a description
    619      * @param String The description of what the commands do
     618     * @param description The description of what the commands do
    620619     */
    621620    private void commitCommands(String description) {
     
    863862
    864863    /**
    865      * This method finds witch ways are outer and witch are inner.
    866      * @param boundaryWays
    867      * @return
     864     * This method finds which ways are outer and which are inner.
     865     * @param boundaries list of joined boundaries to search in
     866     * @return outer ways
    868867     */
    869868    private List<AssembledMultipolygon> findPolygons(Collection<AssembledPolygon> boundaries) {
     
    884883    /**
    885884     * Collects outer way and corresponding inner ways from all boundaries.
     885     * @param level depth level
    886886     * @param boundaryWays
    887887     * @return the outermostWay.
     
    10731073    /**
    10741074     * Tests if way is inside other way
    1075      * @param outside
    1076      * @param inside
    1077      * @return
     1075     * @param outside outer polygon description
     1076     * @param inside inner polygon description
     1077     * @return {@code true} if inner is inside outer
    10781078     */
    10791079    public static boolean wayInsideWay(AssembledPolygon inside, AssembledPolygon outside) {
     
    10941094    /**
    10951095     * Joins the lists of ways.
    1096      * @param Collection<Way> The list of outer ways that belong to that multigon.
    1097      * @return Way The newly created outer way
     1096     * @param polygon The list of outer ways that belong to that multigon.
     1097     * @return The newly created outer way
    10981098     */
    10991099    private Multipolygon  joinPolygon(AssembledMultipolygon polygon) throws UserCancelException {
     
    11091109    /**
    11101110     * Joins the outer ways and deletes all short ways that can't be part of a multipolygon anyway.
    1111      * @param Collection<Way> The list of outer ways that belong to that multigon.
    1112      * @return Way The newly created outer way
     1111     * @param ways The list of outer ways that belong to that multigon.
     1112     * @return The newly created outer way
    11131113     */
    11141114    private Way joinWays(List<WayInPolygon> ways) throws UserCancelException {
     
    11371137    /**
    11381138     * Joins a list of ways (using CombineWayAction and ReverseWayAction as specified in WayInPath)
    1139      * @param ArrayList<Way> The list of ways to join and reverse
    1140      * @return Way The newly created way
     1139     * @param ways The list of ways to join and reverse
     1140     * @return The newly created way
    11411141     */
    11421142    private Way joinOrientedWays(List<WayInPolygon> ways) throws UserCancelException{
     
    12641264    /**
    12651265     * This method filters the list of relations that form the multipolygons.
    1266      * @param relations
    1267      * @param polygons
    1268      * @return
     1266     * @param relations all relations
     1267     * @param polygons polygons for filtering
     1268     * @return relations which don't form the polygons
    12691269     */
    12701270    private List<Relation> filterOwnMultipolygonRelations(Collection<Relation> relations, List<Multipolygon> polygons) {
     
    12871287    /**
    12881288     * Will add own multipolygon relation to the "previously existing" relations. Fixup is done by fixRelations
    1289      * @param Collection<Way> List of already closed inner ways
    1290      * @param Way The outer way
    1291      * @param ArrayList<RelationRole> The list of relation with roles to add own relation to
     1289     * @param inner List of already closed inner ways
     1290     * @param outer The outer way
     1291     * @return The list of relation with roles to add own relation to
    12921292     */
    12931293    private RelationRole addOwnMultigonRelation(Collection<Way> inner, Way outer) {
     
    13081308    /**
    13091309     * Removes a given OsmPrimitive from all relations
    1310      * @param OsmPrimitive Element to remove from all relations
    1311      * @return ArrayList<RelationRole> List of relations with roles the primitives was part of
     1310     * @param osm Element to remove from all relations
     1311     * @return List of relations with roles the primitives was part of
    13121312     */
    13131313    private ArrayList<RelationRole> removeFromAllRelations(OsmPrimitive osm) {
     
    13451345     * relations where the joined areas were in "outer" role a new relation is created instead with all
    13461346     * members of both. This function depends on multigon relations to be valid already, it won't fix them.
    1347      * @param ArrayList<RelationRole> List of relations with roles the (original) ways were part of
    1348      * @param Way The newly created outer area/way
    1349      * @param relationsToDelete - set of relations to delete.
     1347     * @param rels List of relations with roles the (original) ways were part of
     1348     * @param outer The newly created outer area/way
     1349     * @param ownMultipol elements to directly add as outer
     1350     * @param relationsToDelete set of relations to delete.
    13501351     */
    13511352    private void fixRelations(ArrayList<RelationRole> rels, Way outer, RelationRole ownMultipol, Set<Relation> relationsToDelete) {
     
    13991400
    14001401    /**
    1401      * @param Collection<Way> The List of Ways to remove all tags from
     1402     * Remove all tags from the all the way
     1403     * @param ways The List of Ways to remove all tags from
    14021404     */
    14031405    private void stripTags(Collection<Way> ways) {
     
    14101412
    14111413    /**
    1412      * @param Way The Way to remove all tags from
     1414     * Remove all tags from the way
     1415     * @param x The Way to remove all tags from
    14131416     */
    14141417    private void stripTags(Way x) {
     
    14251428     * Takes the last cmdsCount actions back and combines them into a single action
    14261429     * (for when the user wants to undo the join action)
    1427      * @param String The commit message to display
     1430     * @param message The commit message to display
    14281431     */
    14291432    private void makeCommitsOneAction(String message) {
  • trunk/src/org/openstreetmap/josm/command/WayNodesConflictResolverCommand.java

    r5266 r5903  
    3030
    3131    /**
    32      *
    33      * @param my my may
    34      * @param their their way
    35      * @param mergedNodeList  the list of merged nodes
     32     * @param conflict the conflict data set
     33     * @param mergedNodeList the list of merged nodes
    3634     */
    3735    @SuppressWarnings("unchecked")
  • trunk/src/org/openstreetmap/josm/data/projection/Projection.java

    r5548 r5903  
    1515public interface Projection {
    1616    /**
    17      * The default scale factor in east/north units per pixel ({@link #NavigatableComponent#scale})).
     17     * The default scale factor in east/north units per pixel
     18     * ({@link org.openstreetmap.josm.gui.NavigatableComponent#scale})).
    1819     * FIXME: misnomer
    1920     * @return the scale factor
  • trunk/src/org/openstreetmap/josm/gui/MultiSplitLayout.java

    r5874 r5903  
    944944         * @return the Node that comes after this one in the parent's list of children.
    945945         * @see #previousSibling
    946          * @see #getParent
     946         * @see #parent_get
    947947         */
    948948        public Node nextSibling() {
     
    957957         * @return the Node that comes before this one in the parent's list of children.
    958958         * @see #nextSibling
    959          * @see #getParent
     959         * @see #parent_get
    960960         */
    961961        public Node previousSibling() {
  • trunk/src/org/openstreetmap/josm/gui/NameFormatterHook.java

    r4209 r5903  
    3030     * @return The corrected format if needed, null otherwise.
    3131     */
    32     public String checkFormat(IWay node, String defaultName);
     32    public String checkFormat(IWay way, String defaultName);
    3333
    3434    /**
     
    3838     * @return The corrected format if needed, null otherwise.
    3939     */
    40     public String checkFormat(IRelation node, String defaultName);
     40    public String checkFormat(IRelation relation, String defaultName);
    4141}
  • trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java

    r5870 r5903  
    347347     * Zoom to the given coordinate.
    348348     * @param newCenter The center x-value (easting) to zoom to.
    349      * @param scale The scale to use.
     349     * @param newScale The scale to use.
    350350     */
    351351    public void zoomTo(EastNorth newCenter, double newScale) {
     
    396396     * Zoom to the given coordinate without adding to the zoom undo buffer.
    397397     * @param newCenter The center x-value (easting) to zoom to.
    398      * @param scale The scale to use.
     398     * @param newScale The scale to use.
    399399     */
    400400    private void zoomNoUndoTo(EastNorth newCenter, double newScale) {
     
    929929     * @return The nearest way to point p,
    930930     *      prefer a selected way if there are multiple nearest.
    931      * @see #getNearestWaySegment(Point, Collection, Predicate)
     931     * @see #getNearestWaySegment(Point, Predicate)
    932932     *
    933933     * @param p the point for which to search the nearest segment.
     
    985985     *
    986986     * @return Primitives nearest to the given screen point.
    987      * @see #getNearests(Point, Collection, Predicate)
     987     * @see #getNearestNodesOrWays(Point, Collection, Predicate)
    988988     *
    989989     * @param p The point on screen.
     
    10351035     * @return A primitive within snap-distance to point p,
    10361036     *      that is chosen by the algorithm described.
    1037      * @see getNearestNode(Point, Predicate)
    1038      * @see getNearestNodesImpl(Point, Predicate)
    1039      * @see getNearestWay(Point, Predicate)
     1037     * @see #getNearestNode(Point, Predicate)
     1038     * @see #getNearestNodesImpl(Point, Predicate)
     1039     * @see #getNearestWay(Point, Predicate)
    10401040     *
    10411041     * @param p The point on screen.
  • trunk/src/org/openstreetmap/josm/gui/conflict/pair/ComparePairType.java

    r5266 r5903  
    1313
    1414    /**
    15      * compare my version of an {@link OsmPrimitive} with their version
     15     * compare my version of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive} with their version
    1616     */
    1717    MY_WITH_THEIR (tr("My with Their"), new ListRole[] {MY_ENTRIES, THEIR_ENTRIES}),
    1818
    1919    /**
    20      * compare my version of an {@link OsmPrimitive} with the merged version
     20     * compare my version of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive} with the merged version
    2121     */
    2222    MY_WITH_MERGED (tr("My with Merged"),  new ListRole[] {MY_ENTRIES, MERGED_ENTRIES}),
    2323
    2424    /**
    25      * compare their version of an {@link OsmPrimitive} with the merged veresion
     25     * compare their version of an {@link org.openstreetmap.josm.data.osm.OsmPrimitive} with the merged veresion
    2626     */
    2727    THEIR_WITH_MERGED(tr("Their with Merged"),  new ListRole[] {THEIR_ENTRIES, MERGED_ENTRIES});
  • trunk/src/org/openstreetmap/josm/gui/conflict/pair/ConflictResolver.java

    r5297 r5903  
    163163    /**
    164164     * handles property change events
     165     * @param evt the event
     166     * @see TagMergeModel
     167     * @see ListMergeModel
     168     * @see PropertiesMergeModel
    165169     */
    166170    public void propertyChange(PropertyChangeEvent evt) {
     
    223227     * populates the conflict resolver with the conflicts between my and their
    224228     *
    225      * @param my   my primitive (i.e. the primitive in the local dataset)
    226      * @param their their primitive (i.e. the primitive in the server dataset)
    227      *
     229     * @param conflict the conflict data set
    228230     */
    229231    public void populate(Conflict<? extends OsmPrimitive> conflict) {
  • trunk/src/org/openstreetmap/josm/gui/conflict/pair/ListMergeModel.java

    r5335 r5903  
    5555 * A ListMergeModel can be ''frozen''. If it's frozen, it doesn't accept additional merge
    5656 * decisions. {@link PropertyChangeListener}s can register for property value changes of
    57  * {@link #PROP_FROZEN}.
     57 * {@link #FROZEN_PROP}.
    5858 *
    5959 * ListMergeModel is an abstract class. Three methods have to be implemented by subclasses:
    6060 * <ul>
    61  *   <li>{@link ListMergeModel#cloneEntryForMergedList(Object)} - clones an entry of type T</li>
    62  *   <li>{@link ListMergeModel#isEqualEntry(Object, Object)} - checks whether two entries are equals </li>
     61 *   <li>{@link ListMergeModel#cloneEntryForMergedList} - clones an entry of type T</li>
     62 *   <li>{@link ListMergeModel#isEqualEntry} - checks whether two entries are equals </li>
    6363 *   <li>{@link ListMergeModel#setValueAt(DefaultTableModel, Object, int, int)} - handles values edited in
    6464 *     a JTable, dispatched from {@link TableModel#setValueAt(Object, int, int)} </li>
     
    586586     * From the point of view of the {@link JTable} it is a {@link TableModel}.
    587587     *
    588      * @param <T>
    589588     * @see ListMergeModel#getMyTableModel()
    590589     * @see ListMergeModel#getTheirTableModel()
  • trunk/src/org/openstreetmap/josm/gui/conflict/pair/nodes/NodeListMergeModel.java

    r5298 r5903  
    5252     * Builds the command to resolve conflicts in the node list of a way
    5353     *
    54      * @param my  my way. Must not be null.
    55      * @param their  their way. Must not be null
     54     * @param conflict the conflict data set
    5655     * @return the command
    5756     * @exception IllegalStateException thrown, if the merge is not yet frozen
  • trunk/src/org/openstreetmap/josm/gui/dialogs/FilterDialog.java

    r5496 r5903  
    279279
    280280    /**
    281      *
    282      * @param primitive
    283      * @return List of primitives whose filtering can be affected by change in primitive
     281     * Returns the list of primitives whose filtering can be affected by change in primitive
     282     * @param primitives list of primitives to check
     283     * @return List of primitives whose filtering can be affected by change in source primitives
    284284     */
    285285    private Collection<OsmPrimitive> getAffectedPrimitives(Collection<? extends OsmPrimitive> primitives) {
  • trunk/src/org/openstreetmap/josm/gui/dialogs/SelectionListDialog.java

    r5825 r5903  
    464464         * Replies the history of JOSM selections
    465465         *
    466          * @return
     466         * @return history of JOSM selections
    467467         */
    468468        public List<Collection<? extends OsmPrimitive>> getSelectionHistory() {
     
    484484         * of this model
    485485         *
    486          * @return
     486         * @return choosen elements in the view
    487487         */
    488488        public Collection<OsmPrimitive> getSelected() {
     
    500500         * of this model
    501501         *
    502          * @return
     502         * @return complete content of the view
    503503         */
    504504        public Collection<OsmPrimitive> getAllElements() {
  • trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManager.java

    r5890 r5903  
    209209     * in the changeset table.
    210210     *
    211      * @return
     211     * @return changset actions panel
    212212     */
    213213    protected JPanel buildChangesetTableActionPanel() {
     
    607607     * respective changesets are already present in the local changeset cache.
    608608     *
    609      * @param ids the collection of changesets. If null, the selection is cleared.
     609     * @param changesets the collection of changesets. If {@code null}, the
     610     * selection is cleared.
    610611     */
    611612    public void setSelectedChangesets(Collection<Changeset> changesets) {
  • trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetContentDownloadTask.java

    r5266 r5903  
    8787     * Creates a download task for a single changeset
    8888     *
    89      * @param parent the parent component for the {@link PleaseWaitDialog}. Must not be null.
    90      * @param changesetId the changeset id. >0 required.
    91      * @throws IllegalArgumentException thrown if changesetId <= 0
    92      * @throws IllegalArgumentException thrown if parent is null
     89     * @param parent the parent component for the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}. Must not be {@code null}.
     90     * @param changesetId the changeset id. {@code >0} required.
     91     * @throws IllegalArgumentException thrown if {@code changesetId <= 0}
     92     * @throws IllegalArgumentException thrown if parent is {@code null}
    9393     */
    9494    public ChangesetContentDownloadTask(Component parent, int changesetId) throws IllegalArgumentException{
     
    103103     * the collection are sillently discarded.
    104104     *
    105      * @param parent the parent component for the {@link PleaseWaitDialog}. Must not be null.
    106      * @param changesetIds the changeset ids. Empty collection assumed, if null.
    107      * @throws IllegalArgumentException thrown if parent is null
     105     * @param parent the parent component for the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}. Must not be {@code null}.
     106     * @param changesetIds the changeset ids. Empty collection assumed, if {@code null}.
     107     * @throws IllegalArgumentException thrown if parent is {@code null}
    108108     */
    109109    public ChangesetContentDownloadTask(Component parent, Collection<Integer> changesetIds) throws IllegalArgumentException {
  • trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java

    r5266 r5903  
    5353     * Ignores null values and changesets with {@link Changeset#isNew()} == true.
    5454     *
    55      * @param parent the parent component relative to which the {@link PleaseWaitDialog} is displayed.
     55     * @param parent the parent component relative to which the {@link org.openstreetmap.josm.gui.PleaseWaitDialog} is displayed.
    5656     * Must not be null.
    5757     * @param changesets the collection of changesets. Assumes an empty collection if null.
     
    101101
    102102    /**
    103      * Creates the download task for a collection of changeset ids. Uses a {@link PleaseWaitDialog}
     103     * Creates the download task for a collection of changeset ids. Uses a {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
    104104     * whose parent is {@link Main#parent}.
    105105     *
     
    115115
    116116    /**
    117      * Creates the download task for a collection of changeset ids. Uses a {@link PleaseWaitDialog}
     117     * Creates the download task for a collection of changeset ids. Uses a {@link org.openstreetmap.josm.gui.PleaseWaitDialog}
    118118     * whose parent is the parent window of <code>dialogParent</code>.
    119119     *
    120120     * Null ids or or ids <= 0 in the id collection are ignored.
    121121     *
    122      * @param dialogParent the parent reference component for the {@link PleaseWaitDialog}. Must not be null.
     122     * @param dialogParent the parent reference component for the {@link org.openstreetmap.josm.gui.PleaseWaitDialog}. Must not be null.
    123123     * @param ids the collection of ids. Empty collection assumed if null.
    124124     * @throws IllegalArgumentException thrown if dialogParent is null
  • trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/ChangesetQueryTask.java

    r5890 r5903  
    6565     * Creates the task.
    6666     *
    67      * @param parent the parent component relative to which the {@link PleaseWaitDialog} is displayed.
     67     * @param parent the parent component relative to which the {@link org.openstreetmap.josm.gui.PleaseWaitDialog} is displayed.
    6868     * Must not be null.
    6969     * @param query the query to submit to the OSM server. Must not be null.
  • trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java

    r5724 r5903  
    429429     * builds the panel with the table displaying the currently selected primitives
    430430     *
    431      * @return
     431     * @return panel with current selection
    432432     */
    433433    protected JPanel buildSelectionTablePanel() {
     
    466466     * build the panel with the buttons on the left
    467467     *
    468      * @return
     468     * @return left button panel
    469469     */
    470470    protected JToolBar buildLeftButtonPanel() {
     
    535535     * build the panel with the buttons for adding or removing the current selection
    536536     *
    537      * @return
     537     * @return control buttons panel for selection/members
    538538     */
    539539    protected JToolBar buildSelectionControlButtonPanel() {
Note: See TracChangeset for help on using the changeset viewer.