Commits

Michael Ludwig committed 18cb0e3

Javadoc fixes.

  • Participants
  • Parent commits 49027ab

Comments (0)

Files changed (3)

File src/main/java/com/googlecode/entreri/Component.java

      * TypedId hasn't yet been created a new one is instantiated with the next
      * numeric id in the internal id sequence. The new TypedId is stored for
      * later, so that subsequent calls to {@link #getTypedId(Class)} with
-     * <tt>type</tt> will return the same instance.
-     * {@link Component#Component()} implicitly calls this method when a
-     * Component is created.
+     * <tt>type</tt> will return the same instance. It is recommended that a
+     * Component declare a static final <tt>ID</tt> holding its TypedId.
      * </p>
      * <p>
      * This method also performs runtime checks to ensure the validity of the

File src/main/java/com/googlecode/entreri/Entity.java

      * component can be safely stored in collections.
      * 
      * @param <T> The parameterized type of Component being fetched
-     * @param id The TypedId representing the given type
+     * @param componentId The TypedId representing the given type
      * @return The current Component of type T attached to this container
      * @throws NullPointerException if id is null
      */

File src/main/java/com/googlecode/entreri/property/AbstractIndexedDataStore.java

 
     /**
      * Compute the array length of the given array. The array object will have
-     * been created by {@link #createArray(int)} or returned by
-     * {@link #getArray()} so casts are safe.
+     * been returned by {@link #getArray()} so casts are safe.
      * 
      * @param array The array whose length is computed
      * @return The array length