svn commit: r1357597 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ChildNodeEntry.java

[mduerig]

Author: mduerig
Date: Thu Jul  5 13:30:56 2012
New Revision: 1357597

URL: http://svn.apache.org/viewvc?rev=1357597&view=rev
Log:
OAK-18: Define Oak API
 javadoc

Modified:
    
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ChildNodeEntry.java

Modified: 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ChildNodeEntry.java
URL: 
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ChildNodeEntry.java?rev=1357597&r1=1357596&r2=1357597&view=diff
==============================================================================
--- 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ChildNodeEntry.java
 (original)
+++ 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/state/ChildNodeEntry.java
 Thu Jul  5 13:30:56 2012
@@ -20,8 +20,8 @@ package org.apache.jackrabbit.oak.spi.st
 import javax.annotation.Nonnull;
 
 /**
- * TODO: document OR replace by mk.model ChildNodeEntry interface
- *
+ * A {@code ChildNodeEntry} instance represents the child node states of a
+ * {@link NodeState}.
  * <h2>Equality and hash codes</h2>
  * <p>
  * Two child node entries are considered equal if and only if their names
@@ -34,13 +34,15 @@ import javax.annotation.Nonnull;
 public interface ChildNodeEntry {
 
     /**
-     * TODO: document
+     * The name of the child node state wrt. to its parent state.
+     * @return  name of the child node
      */
     @Nonnull
     String getName();
 
     /**
-     * TODO: document
+     * The child node state
+     * @return child node state
      */
     @Nonnull
     NodeState getNodeState();