Changeset 12540 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2017-07-30T06:19:58+02:00 (7 years ago)

Author:

Don-vip

Message:

checkstyle - SingleLineJavadocCheck

Location:

trunk/src/org/openstreetmap/josm/data

Files:

• notes/Note.java (modified) (5 diffs)
• notes/NoteComment.java (modified) (2 diffs)
• osm/NoteData.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/data/notes/Note.java

@@ -79 +79 @@
     }
 
-    /** @return The unique OSM ID of this note */
+    /**
+     * Returns the unique OSM ID of this note.
+     * @return The unique OSM ID of this note
+     */
     public long getId() {
         return id;
@@ -92 +95 @@
     }
 
-    /** @return The geographic location of the note */
+    /**
+     * Returns the geographic location of the note.
+     * @return The geographic location of the note
+     */
     public LatLon getLatLon() {
         return latLon;
     }
 
-    /** @return Date that this note was submitted */
+    /**
+     * Returns the date at which this note was submitted.
+     * @return Date that this note was submitted
+     */
     public Date getCreatedAt() {
         return DateUtils.cloneDate(createdAt);
@@ -110 +119 @@
     }
 
-    /** @return Date that this note was closed. Null if it is still open. */
+    /**
+     * Returns the date at which this note was closed.
+     * @return Date that this note was closed. Null if it is still open.
+     */
     public Date getClosedAt() {
         return DateUtils.cloneDate(closedAt);
@@ -123 +135 @@
     }
 
-    /** @return The open or closed state of this note */
+    /**
+     * Returns the open or closed state of this note.
+     * @return The open or closed state of this note
+     */
     public State getState() {
         return state;
@@ -136 +151 @@
     }
 
-    /** @return An ordered list of comments associated with this note */
+    /**
+     * Returns the list of comments associated with this note.
+     * @return An ordered list of comments associated with this note
+     */
     public List<NoteComment> getComments() {
         return comments;

trunk/src/org/openstreetmap/josm/data/notes/NoteComment.java

@@ -58 +58 @@
     }
 
-    /** @return Plain text of user's comment */
+    /**
+     * Returns Plain text of user's comment.
+     * @return Plain text of user's comment
+     */
     public String getText() {
         return text;
     }
 
-    /** @return JOSM's User object for the user who made this comment */
+    /**
+     * Returns the user who made this comment.
+     * @return JOSM's User object for the user who made this comment
+     */
     public User getUser() {
         return user;
     }
 
-    /** @return The time at which this comment was created */
+    /**
+     * Returns the time at which this comment was created.
+     * @return The time at which this comment was created
+     */
     public Date getCommentTimestamp() {
         return DateUtils.cloneDate(commentTimestamp);
     }
 
-    /** @return the action associated with this note */
+    /**
+     * Returns the action associated with this note.
+     * @return the action associated with this note
+     */
     public Action getNoteAction() {
         return action;
@@ -86 +98 @@
     }
 
-    /** @return true if this is a new comment/action and needs to be uploaded to the API */
+    /**
+     * Determines if this is a new comment/action and needs to be uploaded to the API
+     * @return true if this is a new comment/action and needs to be uploaded to the API
+     */
     public boolean isNew() {
         return isNew;

trunk/src/org/openstreetmap/josm/data/osm/NoteData.java

@@ -265 +265 @@
     }
 
-    /** @return The current comparator being used to sort the note list */
+    /**
+     * Returns the current comparator being used to sort the note list.
+     * @return The current comparator being used to sort the note list
+     */
     public Comparator<Note> getCurrentSortMethod() {
         return comparator;