Changeset 34271 in osm for applications/editors/josm

Timestamp:

2018-06-11T21:21:40+02:00 (6 years ago)

Author:

donvip

Message:

fix some javadoc issues

Location:

applications/editors/josm/plugins/reverter/src/reverter/corehacks

Files:

• OsmChangesetContentParser.java (modified) (2 diffs)
• OsmServerChangesetReader.java (modified) (6 diffs)

applications/editors/josm/plugins/reverter/src/reverter/corehacks/OsmChangesetContentParser.java

@@ -287 +287 @@
      * @param source the input stream with the changeset content as XML document. Must not be null.
      * @throws IllegalArgumentException thrown if source is null.
+     * @throws UnsupportedEncodingException if the named charset is not supported
      */
     public OsmChangesetContentParser(InputStream source) throws UnsupportedEncodingException {
@@ -303 +304 @@
      * Parses the content
      *
-     * @param progressMonitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE}
+     * @param progressMonitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE}
      * if null
      * @return the parsed data

applications/editors/josm/plugins/reverter/src/reverter/corehacks/OsmServerChangesetReader.java

@@ -16 +16 @@
 import org.openstreetmap.josm.data.osm.Changeset;
 import org.openstreetmap.josm.data.osm.DataSet;
+import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
@@ -27 +28 @@
 
 /**
- * Reads the history of an {@see OsmPrimitive} from the OSM API server.
+ * Reads the history of an {@link OsmPrimitive} from the OSM API server.
  *
  */
@@ -52 +53 @@
      * Queries a list
      * @param query  the query specification. Must not be null.
-     * @param monitor a progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null
+     * @param monitor a progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the list of changesets read from the server
      * @throws IllegalArgumentException thrown if query is null
@@ -83 +84 @@
      * Reads the changeset with id <code>id</code> from the server
      *
-     * @param id  the changeset id. id > 0 required.
-     * @param monitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null
+     * @param id  the changeset id. id &gt; 0 required.
+     * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the changeset read
      * @throws OsmTransferException thrown if something goes wrong
-     * @throws IllegalArgumentException if id <= 0
+     * @throws IllegalArgumentException if id &lt;= 0
      */
     public Changeset readChangeset(long id, ProgressMonitor monitor) throws OsmTransferException {
@@ -119 +120 @@
      * Reads the changeset with id <code>id</code> from the server
      *
-     * @param ids  the list of ids. Ignored if null. Only load changesets for ids > 0.
-     * @param monitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if null
+     * @param ids  the list of ids. Ignored if null. Only load changesets for ids &gt; 0.
+     * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the changeset read
      * @throws OsmTransferException thrown if something goes wrong
-     * @throws IllegalArgumentException if id <= 0
+     * @throws IllegalArgumentException if id &lt;= 0
      */
     public List<Changeset> readChangesets(Collection<Integer> ids, ProgressMonitor monitor) throws OsmTransferException {
@@ -168 +169 @@
      * Downloads the content of a changeset
      *
-     * @param id the changeset id. >0 required.
-     * @param monitor the progress monitor. {@see NullProgressMonitor#INSTANCE} assumed if null.
+     * @param id the changeset id. &gt;0 required.
+     * @param monitor the progress monitor. {@link NullProgressMonitor#INSTANCE} assumed if null.
      * @return the changeset content
-     * @throws IllegalArgumentException thrown if id <= 0
+     * @throws IllegalArgumentException thrown if id &lt;= 0
      * @throws OsmTransferException thrown if something went wrong
      */