You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2016/09/02 09:29:58 UTC

svn commit: r1758918 - in /directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util: JndiUtils.java tree/DnNode.java

Author: elecharny
Date: Fri Sep  2 09:29:58 2016
New Revision: 1758918

URL: http://svn.apache.org/viewvc?rev=1758918&view=rev
Log:
Updated Javadocs

Modified:
    directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java
    directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java

Modified: directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java?rev=1758918&r1=1758917&r2=1758918&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java (original)
+++ directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/JndiUtils.java Fri Sep  2 09:29:58 2016
@@ -278,7 +278,7 @@ public final class JndiUtils
     /**
      * Convert a Dn to a {@link javax.naming.Name}
      *
-     * @param name The Dn to convert
+     * @param dn The Dn to convert
      * @return A Name
      */
     public static Name toName( Dn dn )

Modified: directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java?rev=1758918&r1=1758917&r2=1758918&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java (original)
+++ directory/shared/trunk/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java Fri Sep  2 09:29:58 2016
@@ -36,13 +36,13 @@ import org.slf4j.LoggerFactory;
 
 
 /**
- * A class storing nodes in a tree designed to map DNs.<br/>
+ * A class storing nodes in a tree designed to map DNs.<br>
  * Branch nodes in this tree refers to child nodes. Leaf nodes in the tree
- * don't have any children. <br/>
+ * don't have any children. <br>
  * A node may contain a reference to an object whose suffix is the path through the
- * nodes of the tree from the root. <br/>
- * A node may also have no attached element.<br/>
- * Each child node is referenced by a Rdn, and holds the full Dn corresponding to its position<br/>
+ * nodes of the tree from the root. <br>
+ * A node may also have no attached element.<br>
+ * Each child node is referenced by a Rdn, and holds the full Dn corresponding to its position<br>
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @param <N> The type of node we store
@@ -553,7 +553,7 @@ public class DnNode<N> implements Clonea
 
     /**
      * Add a new node in the tree. We can't add a node if its Dn is empty. The
-     * added element is attached to the node, which is named by the Dn's Rdn.<br/>
+     * added element is attached to the node, which is named by the Dn's Rdn.<br>
      *
      * @param dn The node's Dn
      * @param element The element to associate with this Node. Can be null.
@@ -848,7 +848,6 @@ public class DnNode<N> implements Clonea
      * dc=acme, dc=org will be returned if it has an associated element.
      * <br>For the Dn ou=apache, dc=org, there is no parent, so null will be returned.
      *
-     * @param dn the normalized distinguished name to resolve to a parent
      * @return the Node associated with the normalized dn
      */
     public synchronized DnNode<N> getParentWithElement()
@@ -873,7 +872,7 @@ public class DnNode<N> implements Clonea
      * rename the DnNode's Dn
      * 
      * @param newRdn the new Rdn of this node
-     * @throws LdapException
+     * @throws LdapException If the rename failed
      */
     public synchronized void rename( Rdn newRdn ) throws LdapException
     {
@@ -899,7 +898,7 @@ public class DnNode<N> implements Clonea
      * move the DnNode's Dn
      *
      * @param newParent the new parent Dn
-     * @throws LdapException
+     * @throws LdapException If the move failed
      */
     public synchronized void move( Dn newParent ) throws LdapException
     {