Changeset 5881 in josm for trunk


Ignore:
Timestamp:
2013-04-18T19:03:55+02:00 (7 years ago)
Author:
stoecker
Message:

javadoc fixes

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

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/command/RelationMemberConflictResolverCommand.java

    r5266 r5881  
    3838     * @param my my relation
    3939     * @param their their relation
    40      * @param mergedNodeList the list of merged relation members
     40     * @param mergedMembers the list of merged relation members
    4141     */
    4242    public RelationMemberConflictResolverCommand(Relation my, Relation their, List<RelationMember> mergedMembers) {
  • trunk/src/org/openstreetmap/josm/data/Version.java

    r5874 r5881  
    230230     * Returns the full User-Agent string
    231231     * @return The User-Agent
    232      * @since 5866
     232     * @since 5868
    233233     */
    234234    public String getFullAgentString() {
  • trunk/src/org/openstreetmap/josm/data/osm/DataSet.java

    r5798 r5881  
    135135     * This method can be used to detect changes in highlight state of primitives. If highlighting was changed
    136136     * then the method will return different number.
    137      * @return
     137     * @return the current highlight counter
    138138     */
    139139    public int getHighlightUpdateCount() {
     
    149149     * Replies the history of JOSM selections
    150150     *
    151      * @return
     151     * @return list of history entries
    152152     */
    153153    public LinkedList<Collection<? extends OsmPrimitive>> getSelectionHistory() {
     
    371371     * primitive are left unchanged.
    372372     *
    373      * @param primitive the primitive
     373     * @param primitiveId the id of the primitive
    374374     */
    375375    public void removePrimitive(PrimitiveId primitiveId) {
     
    556556     * *WaySegments* to avoid a VirtualNode class that wouldn't have much use
    557557     * otherwise.
    558      * @param Collection of waySegments
     558     * @param waySegments Collection of way segments
    559559     */
    560560    public void setHighlightedVirtualNodes(Collection<WaySegment> waySegments) {
     
    569569    /**
    570570     * set what virtual ways should be highlighted.
    571      * @param Collection of waySegments
     571     * @param waySegments Collection of way segments
    572572     */
    573573    public void setHighlightedWaySegments(Collection<WaySegment> waySegments) {
     
    681681    /**
    682682     * Remove the selection from every value in the collection.
    683      * @param list The collection to remove the selection from.
     683     * @param osm The collection of ids to remove the selection from.
    684684     */
    685685    public void clearSelection(PrimitiveId... osm) {
     
    950950    /**
    951951     * Can be called before bigger changes on dataset. Events are disabled until {@link #endUpdate()}.
    952      * {@link DataSetListener#dataChanged()} event is triggered after end of changes
     952     * {@link DataSetListener#dataChanged(DataChangedEvent event)} event is triggered after end of changes
    953953     * <br>
    954954     * Typical usecase should look like this:
     
    10551055     *
    10561056     * This method can be invoked after the globally configured projection method
    1057      * changed. In contrast to {@link DataSet#reproject()} it only invalidates the
    1058      * cache and doesn't reproject the coordinates.
     1057     * changed.
    10591058     */
    10601059    public void invalidateEastNorthCache() {
  • trunk/src/org/openstreetmap/josm/data/osm/DataSetMerger.java

    r5350 r5881  
    4848     * constructor
    4949     *
    50      * The visitor will merge <code>theirDataSet</code> onto <code>myDataSet</code>
    51      *
    52      * @param targetDataSet  dataset with my primitives. Must not be null.
     50     * The visitor will merge <code>sourceDataSet</code> onto <code>targetDataSet</code>
     51     *
     52     * @param targetDataSet dataset with my primitives. Must not be null.
    5353     * @param sourceDataSet dataset with their primitives. Ignored, if null.
    5454     * @throws IllegalArgumentException thrown if myDataSet is null
     
    6565
    6666    /**
    67      * Merges a primitive <code>other</code> of type <P> onto my primitives.
     67     * Merges a primitive onto primitives dataset.
    6868     *
    6969     * If other.id != 0 it tries to merge it with an corresponding primitive from
     
    7171     * in {@link #conflicts}.
    7272     *
    73      * If other.id == 0 it tries to find a primitive in my dataset with id == 0 which
     73     * If other.id == 0 (new primitive) it tries to find a primitive in my dataset with id == 0 which
    7474     * is semantically equal. If it finds one it merges its technical attributes onto
    7575     * my primitive.
    7676     *
    77      * @param <P>  the type of the other primitive
    78      * @param source  the other primitive
     77     * @param source the primitive to merge
     78     * @param candidates a set of possible candidates for a new primitive
    7979     */
    8080    protected void mergePrimitive(OsmPrimitive source, Collection<? extends OsmPrimitive> candidates) {
     
    385385    /**
    386386     * Runs the merge operation. Successfully merged {@link OsmPrimitive}s are in
    387      * {@link #getMyDataSet()}.
     387     * {@link #getTargetDataSet()}.
    388388     *
    389389     * See {@link #getConflicts()} for a map of conflicts after the merge operation.
     
    395395    /**
    396396     * Runs the merge operation. Successfully merged {@link OsmPrimitive}s are in
    397      * {@link #getMyDataSet()}.
     397     * {@link #getTargetDataSet()}.
    398398     *
    399399     * See {@link #getConflicts()} for a map of conflicts after the merge operation.
     
    443443     * replies my dataset
    444444     *
    445      * @return
     445     * @return the own (target) data set
    446446     */
    447447    public DataSet getTargetDataSet() {
  • trunk/src/org/openstreetmap/josm/data/osm/RelationMember.java

    r3844 r5881  
    114114     * @param role Can be null, in this case it's save as ""
    115115     * @param member Cannot be null
    116      * @throw IllegalArgumentException thrown if member is null
     116     * @throws IllegalArgumentException thrown if member is <code>null</code>
    117117     */
    118118    public RelationMember(String role, OsmPrimitive member) throws IllegalArgumentException{
  • trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListener.java

    r5170 r5881  
    3232     * deleted/invisible primitives were resurrected.
    3333     *
    34      * @param added A collection of newly-visible primitives
     34     * @param event An event for an collection of newly-visible primitives
    3535     */
    3636    void primitivesAdded(PrimitivesAddedEvent event);
     
    4040     * primitives were marked as deleted.
    4141     *
    42      * @param removed A collection of newly-invisible primitives
     42     * @param event An event for an collection of newly-invisible primitives
    4343     */
    4444    void primitivesRemoved(PrimitivesRemovedEvent event);
     
    4848     * a tag addition, tag removal or change in tag value.
    4949     *
    50      * @param prim the primitive, whose tags were affected.
     50     * @param event the event for the primitive, whose tags were affected.
    5151     */
    5252    void tagsChanged(TagsChangedEvent event);
     
    5454    /**
    5555     * A node's coordinates were modified.
    56      * @param node The node that was moved.
     56     * @param event The event for the node that was moved.
    5757     */
    5858    void nodeMoved(NodeMovedEvent event);
     
    6060    /**
    6161     * A way's node list was changed.
    62      * @param way The way that was modified.
     62     * @param event The event for the way that was modified.
    6363     */
    6464    void wayNodesChanged(WayNodesChangedEvent event);
     
    6666    /**
    6767     * A relation's members have changed.
    68      * @param relation The relation that was modified.
     68     * @param event The event for the relation that was modified.
    6969     */
    7070    void relationMembersChanged(RelationMembersChangedEvent event);
     
    7373     * Minor dataset change, currently only changeset id changed is supported, but can
    7474     * be extended in future.
    75      * @param event
     75     * @param event the event for data modification
    7676     */
    7777    void otherDatasetChange(AbstractDatasetChangedEvent event);
     
    7979    /**
    8080     * Called after big changes in dataset. Usually other events are stopped using Dataset.beginUpdate() and
    81      * after operation is completed (Dataset.endUpdate()), {@link #dataChanged()} is called.
     81     * after operation is completed (Dataset.endUpdate()), {@link #dataChanged(DataChangedEvent event)} is called.
    8282     */
    8383    void dataChanged(DataChangedEvent event);
  • trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java

    r5170 r5881  
    2222 * new layer is selected)
    2323 *
    24  * Events in EDT are supported, see {@link #addDatasetListener(DataSetListener, FireMode}
     24 * Events in EDT are supported, see {@link #addDatasetListener(DataSetListener, FireMode)}
    2525 *
    2626 */
  • trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/WireframeMapRenderer.java

    r5754 r5881  
    8383    private DataSet ds;
    8484
    85     /** Helper variable for {@link #drawSgement} */
     85    /** Helper variable for {@link #drawSegment} */
    8686    private static final double PHI = Math.toRadians(20);
    87     /** Helper variable for {@link #drawSgement} */
     87    /** Helper variable for {@link #drawSegment} */
    8888    private static final double cosPHI = Math.cos(PHI);
    89     /** Helper variable for {@link #drawSgement} */
     89    /** Helper variable for {@link #drawSegment} */
    9090    private static final double sinPHI = Math.sin(PHI);
    9191
  • trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletionList.java

    r5266 r5881  
    132132     * are not null and which do not exist yet in the list are added.
    133133     *
    134      * @param value a list of strings to add
     134     * @param values a list of strings to add
    135135     * @param priority the priority to use
    136136     */
  • trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java

    r5797 r5881  
    172172    /**
    173173     * Return s new BasicStroke object with given thickness and style
    174      * @param code = 3.5 -> thickness=3.5px
    175      * @param code = 3.5 10 5 -> thickness=3.5px, dashed: 10px filled + 5px empty
     174     * @param code = 3.5 -> thickness=3.5px; 3.5 10 5 -> thickness=3.5px, dashed: 10px filled + 5px empty
     175     * @return stroke for drawing
    176176     */
    177177    public static Stroke getCustomizedStroke(String code) {
  • trunk/src/org/openstreetmap/josm/gui/widgets/HtmlPanel.java

    r5266 r5881  
    1616 * HTML.
    1717 *
    18  * It displays HTML text in the same font as {@link JLabel}. Hyperlinks are rendered in
     18 * It displays HTML text in the same font as {@link javax.swing.JLabel}. Hyperlinks are rendered in
    1919 * blue and they are underlined. There is also a CSS rule for the HTML tag &lt;strong&gt;
    2020 * configured.
  • trunk/src/org/openstreetmap/josm/io/CacheFiles.java

    r4932 r5881  
    5151    /**
    5252     * Creates a new cache class. The ident will be used to store the files on disk and to save
    53      * expire/space settings.
    54      * @param ident
     53     * expire/space settings. Set plugin state to <code>true</code>.
     54     * @param ident cache identifier
    5555     */
    5656    public CacheFiles(String ident) {
     
    5858    }
    5959
     60    /**
     61     * Creates a new cache class. The ident will be used to store the files on disk and to save
     62     * expire/space settings.
     63     * @param ident cache identifier
     64     * @param isPlugin Whether this is a plugin or not (changes cache path)
     65     */
    6066    public CacheFiles(String ident, boolean isPlugin) {
    6167        String pref = isPlugin ?
     
    8793    /**
    8894     * Loads the data for the given ident as an byte array. Returns null if data not available.
    89      * @param ident
    90      * @return
     95     * @param ident cache identifier
     96     * @return stored data
    9197     */
    9298    public byte[] getData(String ident) {
     
    118124    /**
    119125     * Writes an byte-array to disk
    120      * @param ident
    121      * @param data
     126     * @param ident cache identifier
     127     * @param data data to store
    122128     */
    123129    public void saveData(String ident, byte[] data) {
     
    140146    /**
    141147     * Loads the data for the given ident as an image. If no image is found, null is returned
    142      * @param ident Identifier
     148     * @param ident cache identifier
    143149     * @return BufferedImage or null
    144150     */
     
    167173    /**
    168174     * Saves a given image and ident to the cache
    169      * @param ident
    170      * @param image
     175     * @param ident cache identifier
     176     * @param image imaga data for storage
    171177     */
    172178    public void saveImg(String ident, BufferedImage image) {
     
    211217
    212218    /**
    213      * Call this with true to update the last modification time when a file it is read.
    214      * Call this with false to not update the last modification time when a file is read.
    215      * @param to
     219     * Call this with <code>true</code> to update the last modification time when a file it is read.
     220     * Call this with <code>false</code> to not update the last modification time when a file is read.
     221     * @param to update state
    216222     */
    217223    public void setUpdateModTime(boolean to) {
     
    323329    /**
    324330     * Gets file path for ident with customizable file-ending
    325      * @param ident
    326      * @param ending
    327      * @return File
     331     * @param ident cache identifier
     332     * @param ending file extension
     333     * @return file structure
    328334     */
    329335    private File getPath(String ident, String ending) {
     
    333339    /**
    334340     * Gets file path for ident
    335      * @param ident
    336      * @param ending
    337      * @return File
     341     * @param ident cache identifier
     342     * @return file structure
    338343     */
    339344    private File getPath(String ident) {
     
    343348    /**
    344349     * Checks whether a given file is expired
    345      * @param file
    346      * @return expired?
     350     * @param file file description structure
     351     * @return expired state
    347352     */
    348353    private boolean isExpired(File file) {
  • trunk/src/org/openstreetmap/josm/io/OsmApi.java

    r5874 r5881  
    296296    /**
    297297     * Makes an XML string from an OSM primitive. Uses the OsmWriter class.
    298      * @param o the OSM primitive
    299      * @param addBody true to generate the full XML, false to only generate the encapsulating tag
     298     * @param s the changeset
    300299     * @return XML string
    301300     */
  • trunk/src/org/openstreetmap/josm/io/OsmChangeReader.java

    r5345 r5881  
    2020     * constructor (for private and subclasses use only)
    2121     *
    22      * @see #parseDataSet(InputStream, DataSet, ProgressMonitor)
     22     * @see #parseDataSet(InputStream, ProgressMonitor)
    2323     */
    2424    protected OsmChangeReader() {
     
    9090     * Parse the given input source and return the dataset.
    9191     *
    92      * @param source the source input stream. Must not be null.
    93      * @param progressMonitor  the progress monitor. If null, {@link NullProgressMonitor#INSTANCE} is assumed
     92     * @param source the source input stream. Must not be <code>null</code>.
     93     * @param progressMonitor  the progress monitor. If <code>null</code>,
     94     * {@link org.openstreetmap.josm.gui.progress.NullProgressMonitor#INSTANCE} is assumed
    9495     *
    9596     * @return the dataset with the parsed data
    9697     * @throws IllegalDataException thrown if the an error was found while parsing the data from the source
    97      * @throws IllegalArgumentException thrown if source is null
     98     * @throws IllegalArgumentException thrown if source is <code>null</code>
    9899     */
    99100    public static DataSet parseDataSet(InputStream source, ProgressMonitor progressMonitor) throws IllegalDataException {
  • trunk/src/org/openstreetmap/josm/io/OsmConnection.java

    r4690 r5881  
    142142     *
    143143     * @return true if this connection is canceled
    144      * @return
    145144     */
    146145    public boolean isCanceled() {
  • trunk/src/org/openstreetmap/josm/io/OsmHistoryReader.java

    r5346 r5881  
    3333 *
    3434 * It is slightly different from {@link OsmReader} because we don't build an internal graph of
    35  * {@link OsmPrimitive}s. We use objects derived from {@link HistoryOsmPrimitive} instead and we
    36  * keep the data in a dedicated {@link HistoryDataSet}.
     35 * {@link org.openstreetmap.josm.data.osm.OsmPrimitive}s. We use objects derived from
     36 * {@link HistoryOsmPrimitive} instead and we keep the data in a dedicated {@link HistoryDataSet}.
    3737 *
    3838 */
  • trunk/src/org/openstreetmap/josm/io/OsmReader.java

    r5859 r5881  
    7373     * constructor (for private and subclasses use only)
    7474     *
    75      * @see #parseDataSet(InputStream, DataSet, ProgressMonitor)
     75     * @see #parseDataSet(InputStream, ProgressMonitor)
    7676     */
    7777    protected OsmReader() {
  • trunk/src/org/openstreetmap/josm/io/OsmServerBackreferenceReader.java

    r5874 r5881  
    7979
    8080    /**
    81      * constructor
    82      *
    83      * @param id  the id of the primitive. > 0 expected
    84      * @param readFull true, if referers should be read fully (i.e. including their immediate children)
     81     * Creates a back reference reader for given primitive
     82     *
     83     * @param primitive the primitive
     84     * @param readFull <code>true</code>, if referers should be read fully (i.e. including their immediate children)
    8585     *
    8686     */
     
    9191
    9292    /**
    93      * constructor
    94      *
    95      * @param primitive the primitive whose referers are to be read
     93     * Creates a back reference reader for given primitive id
     94     *
     95     * @param id the id of the primitive whose referers are to be read
     96     * @param type the type of the primitive
    9697     * @param readFull true, if referers should be read fully (i.e. including their immediate children)
    9798     *
     
    196197     *
    197198     * <ul>
    198      *   <li>if this reader reads referers for a {@link Node}, referring ways are always
     199     *   <li>if this reader reads referers for a {@link org.openstreetmap.josm.data.osm.Node}, referring ways are always
    199200     *     read individually from the server</li>
    200201     *   <li>if this reader reads referers for an {@link Way} or a {@link Relation}, referring relations
  • trunk/src/org/openstreetmap/josm/tools/PlatformHookUnixoid.java

    r5877 r5881  
    9999                if (line != null && !line.isEmpty()) {
    100100                    line = line.replaceAll("\"+","");
     101                    line = line.replaceAll("NAME=",""); // strange code for some Gentoo's
    101102                    if(line.startsWith("Linux ")) // e.g. Linux Mint
    102103                        return line;
  • trunk/src/org/openstreetmap/josm/tools/Utils.java

    r5874 r5881  
    598598     * @return An buffered stream reader for the given URL (using UTF-8)
    599599     * @throws IOException if an I/O exception occurs.
    600      * @since 5867
     600     * @since 5868
    601601     */
    602602    public static BufferedReader openURLReader(URL url) throws IOException {
Note: See TracChangeset for help on using the changeset viewer.