Changeset 5417 in josm

Timestamp:

2012-08-10T12:51:52+02:00 (12 years ago)

Author:

stoecker

Message:

some Javadoc fixes

Location:

trunk/src/org/openstreetmap/josm/data/osm

Files:

• AbstractPrimitive.java (modified) (9 diffs)
• PrimitiveId.java (modified) (1 diff)

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

@@ -17 +17 @@
 import java.util.concurrent.atomic.AtomicLong;
 
+/**
+* Abstract class to represent common features of the datatypes primitives.
+*
+* @since 4099
+*/
 public abstract class AbstractPrimitive implements IPrimitive {
 
@@ -94 +99 @@
      * Get and write all attributes from the parameter. Does not fire any listener, so
      * use this only in the data initializing phase
+     * @param other the primitive to clone data from
      */
     public void cloneFrom(AbstractPrimitive other) {
@@ -122 +128 @@
      * if this primitive is incomplete.
      *
-     * @see #setVersion(int)
+     * @see PrimitiveData#setVersion(int)
      */
     @Override
@@ -141 +147 @@
 
     /**
+     * Gets a unique id representing this object.
      *
      * @return Osm id if primitive already exists on the server. Unique negative value if primitive is new
@@ -283 +290 @@
      * used to check against edit conflicts.
      *
+     * @return date of last modification
      */
     @Override
@@ -351 +359 @@
 
     /**
-     * Replies <code>true</code>, if the object is usable (i.e. complete
-     * and not deleted).
+     * Replies <code>true</code>, if the object is usable
+     * (i.e. complete and not deleted).
      *
      * @return <code>true</code>, if the object is usable.
-     * @see #delete(boolean)
+     * @see #setDeleted(boolean)
      */
     public boolean isUsable() {
@@ -362 +370 @@
 
     /**
+     * Checks if objects is known to the server.
      * Replies true if this primitive is either unknown to the server (i.e. its id
      * is 0) or it is known to the server and it hasn't be deleted on the server.
@@ -367 +376 @@
      * on the server.
      *
+     * @return <code>true</code>, if the object is visible on server.
      * @see #setVisible(boolean)
      */
@@ -625 +635 @@
 
     /**
-     * Replies true if this primitive has a tag with key <code>key</code>
+     * Replies true if this primitive has a tag with key <code>key</code>.
      *
      * @param key the key

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

@@ -2 +2 @@
 package org.openstreetmap.josm.data.osm;
 
+/**
+* interface to represent identifaction and type of the datatypes primitives.
+*
+* @since 2399
+*/
 public interface PrimitiveId {
 
+    /**
+     * Gets a unique id representing this object (the OSM server id for OSM objects)
+     *
+     * @return the id number
+     */
     long getUniqueId();
+
+    /**
+     * Gets the type of object represented by this object.
+     *
+     * @see Node
+     * @see Way
+     * @see Relation
+     * @return the object type
+     */
     OsmPrimitiveType getType();