directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r470116 - in /directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap: codec/ codec/extended/operations/ codec/util/ exception/ filter/ ldif/ message/ message/extended/ name/ schema/ subtree/ util/
Date Wed, 01 Nov 2006 22:04:37 GMT
Author: elecharny
Date: Wed Nov  1 14:04:34 2006
New Revision: 470116

URL: http://svn.apache.org/viewvc?view=rev&rev=470116
Log:
Fixed all javadoc failures and warnings

Modified:
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/LdapStatesEnum.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/TwixDecoder.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulDisconnectContainer.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulShutdownContainer.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/util/LdapURL.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapAuthenticationException.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapTimeLimitExceededException.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AbstractExprNode.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/ScopeNode.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SubstringNode.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/Entry.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifComposerImpl.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifReader.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/AddRequestImpl.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/CompareRequest.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/DeleteRequest.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LdapResultImpl.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LockableAttributeImpl.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/Referral.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResponseCarryingMessageException.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResultCodeEnum.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequestImpl.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntry.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntryImpl.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/extended/GracefulDisconnect.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/LdapDN.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/RdnParser.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/schema/DescriptionUtils.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/subtree/BaseSubtreeSpecification.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ClassUtils.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/DNUtils.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/NamespaceTools.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/Nestable.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ToStringStyle.java
    directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ValuedEnum.java

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/LdapStatesEnum.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/LdapStatesEnum.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/LdapStatesEnum.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/LdapStatesEnum.java Wed Nov  1 14:04:34 2006
@@ -336,10 +336,7 @@
     /**
      * Get the string representing the state
      * 
-     * @param grammar
-     *            The current grammar being used
-     * @param state
-     *            The state number
+     * @param state The state number
      * @return The String representing the state
      */
     public String getState( int state )

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/TwixDecoder.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/TwixDecoder.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/TwixDecoder.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/TwixDecoder.java Wed Nov  1 14:04:34 2006
@@ -68,8 +68,8 @@
     /**
      * Creates an instance of a Twix Decoder implementation.
      * 
-     * @param provider
-     *            the owning provider.
+     * @param provider the owning provider.
+     * @param binaries The binary attributes set
      */
     public TwixDecoder(Provider provider, Set binaries)
     {
@@ -82,7 +82,7 @@
     /**
      * Decodes a PDU
      * 
-     * @param encodedThe PDU containing the LdapMessage to decode
+     * @param encoded The PDU containing the LdapMessage to decode
      * @throws DecoderExceptionIf anything went wrong
      */
     public void decode( Object encoded ) throws DecoderException

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulDisconnectContainer.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulDisconnectContainer.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulDisconnectContainer.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulDisconnectContainer.java Wed Nov  1 14:04:34 2006
@@ -61,7 +61,7 @@
      * Set a GracefulDisconnect Object into the container. It will be completed
      * by the ldapDecoder.
      * 
-     * @param control the GracefulShutdown to set.
+     * @param gracefulDisconnect the GracefulShutdown to set.
      */
     public void setGracefulDisconnect( GracefulDisconnect gracefulDisconnect )
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulShutdownContainer.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulShutdownContainer.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulShutdownContainer.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/extended/operations/GracefulShutdownContainer.java Wed Nov  1 14:04:34 2006
@@ -61,7 +61,7 @@
      * Set a GracefulShutdown Object into the container. It will be completed by
      * the ldapDecoder.
      * 
-     * @param control the GracefulShutdown to set.
+     * @param gracefulShutdown the GracefulShutdown to set.
      */
     public void setGracefulShutdown( GracefulShutdown gracefulShutdown )
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/util/LdapURL.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/util/LdapURL.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/util/LdapURL.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/codec/util/LdapURL.java Wed Nov  1 14:04:34 2006
@@ -295,8 +295,7 @@
      * Create a new LdapURL from a String after having parsed it.
      * 
      * @param string TheString that contains the LDAPURL
-     * @return A MutableString containing the LDAPURL
-     * @throws DecoderException If the String does not comply with RFC 2255
+     * @throws LdapURLEncodingException If the String does not comply with RFC 2255
      */
     public LdapURL( String string ) throws LdapURLEncodingException
     {
@@ -322,8 +321,7 @@
      * Create a new LdapURL after having parsed it.
      * 
      * @param bytes The byte buffer that contains the LDAPURL
-     * @return A MutableString containing the LDAPURL
-     * @throws DecoderException If the byte array does not comply with RFC 2255
+     * @throws LdapURLEncodingException If the byte array does not comply with RFC 2255
      */
     public LdapURL(byte[] bytes) throws LdapURLEncodingException
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapAuthenticationException.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapAuthenticationException.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapAuthenticationException.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapAuthenticationException.java Wed Nov  1 14:04:34 2006
@@ -27,7 +27,7 @@
 
 /**
  * A subclass of {@link AuthenticationException} which associates the
- * {@link ResultCodeEnum.INVALIDCREDENTIALS} value with the type.
+ * {@link ResultCodeEnum#INVALIDCREDENTIALS} value with the type.
  * 
  * @see <a
  *      href="http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap-gl.html#EXCEPT">

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapTimeLimitExceededException.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapTimeLimitExceededException.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapTimeLimitExceededException.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/exception/LdapTimeLimitExceededException.java Wed Nov  1 14:04:34 2006
@@ -30,7 +30,7 @@
  * {@link ResultCodeEnum#SIZELIMITEXCEEDED} resultCode with the exception.
  * 
  * @see LdapException
- * @see SizeLimitExceededException
+ * @see LdapSizeLimitExceededException
  * @see <a
  *      href="http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap-gl.html#EXCEPT">
  *      LDAP ResultCode to JNDI Exception Mappings</a>

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AbstractExprNode.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AbstractExprNode.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AbstractExprNode.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AbstractExprNode.java Wed Nov  1 14:04:34 2006
@@ -186,7 +186,7 @@
      * @param a_assertionType
      *            the assertion type value
      * @return the string representation
-     * @todo Refactor these classes to use an enumeration type
+     * TODO Refactor these classes to use an enumeration type
      */
     public static final String getOperationString( int a_assertionType )
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/ScopeNode.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/ScopeNode.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/ScopeNode.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/ScopeNode.java Wed Nov  1 14:04:34 2006
@@ -100,9 +100,9 @@
      * Gets the scope constant for this node.
      * 
      * @return the scope constant
-     * @see SearchControls.OBJECT_SCOPE
-     * @see SearchControls.ONELEVEL_SCOPE
-     * @see SearchControls.SUBTREE_SCOPE
+     * @see javax.naming.directory.SearchControls#OBJECT_SCOPE
+     * @see javax.naming.directory.SearchControls#ONELEVEL_SCOPE
+     * @see javax.naming.directory.SearchControls#SUBTREE_SCOPE
      */
     public int getScope()
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SubstringNode.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SubstringNode.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SubstringNode.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SubstringNode.java Wed Nov  1 14:04:34 2006
@@ -56,11 +56,11 @@
      * Creates a new SubstringNode object with only one wildcard and no internal
      * any fragments between wildcards.
      * 
-     * @param a_attribute
+     * @param attribute
      *            the name of the attribute to substring assert
-     * @param a_initial
+     * @param initialPattern
      *            the initial fragment
-     * @param a_final
+     * @param finalPattern
      *            the final fragment
      */
     public SubstringNode(String attribute, String initialPattern, String finalPattern)
@@ -77,13 +77,13 @@
      * Creates a new SubstringNode object more than one wildcard and an any
      * list.
      * 
-     * @param a_anyList
+     * @param anyPattern
      *            list of internal fragments between wildcards
-     * @param a_attribute
+     * @param attribute
      *            the name of the attribute to substring assert
-     * @param a_initial
+     * @param initialPattern
      *            the initial fragment
-     * @param a_final
+     * @param finalPattern
      *            the final fragment
      */
     public SubstringNode(ArrayList anyPattern, String attribute, String initialPattern, String finalPattern)

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/Entry.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/Entry.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/Entry.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/Entry.java Wed Nov  1 14:04:34 2006
@@ -155,8 +155,7 @@
     /**
      * Add a modification item (used by modify operations)
      * 
-     * @param ModificationItem
-     *            The modification to be added
+     * @param modification The modification to be added
      */
     public void addModificationItem( ModificationItem modification )
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifComposerImpl.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifComposerImpl.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifComposerImpl.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifComposerImpl.java Wed Nov  1 14:04:34 2006
@@ -33,7 +33,7 @@
 /**
  * An LDAP Data Interchange Format (LDIF) composer.
  * 
- * @task Get the RFC for LDIF syntax in this javadoc.
+ * TODO Get the RFC for LDIF syntax in this javadoc.
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Revision$
  */
@@ -42,7 +42,7 @@
     /**
      * Generates an LDIF from a multi map.
      * 
-     * @param a_attrHash
+     * @param attrHash
      *            the multi map of single and multivalued attributes.
      * @return the LDIF as a String.
      */

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifReader.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifReader.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifReader.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/ldif/LdifReader.java Wed Nov  1 14:04:34 2006
@@ -251,8 +251,7 @@
     /**
      * A constructor which takes a file name
      * 
-     * @param in
-     *            A file name containing ldif formated input
+     * @param ldifFileName A file name containing ldif formated input
      * @throws NamingException
      *             If the file cannot be processed or if the format is incorrect
      */
@@ -395,7 +394,7 @@
     /**
      * Parse a number following the rules :
      * 
-     * <number> ::= <digit> <digits> <digits> ::= <digit> <digits> | e <digit>
+     * &lt;number&gt; ::= &lt;digit&gt; &lt;digits&gt; &lt;digits&gt; ::= &lt;digit&gt; &lt;digits&gt; | e &lt;digit&gt;
      * ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
      * 
      * Check that the number is in the interval
@@ -674,15 +673,15 @@
     }
 
     /**
-     * Parse a control. The grammar is : <control> ::= "control:" <fill>
-     * <ldap-oid> <critical-e> <value-spec-e> <sep> <critical-e> ::= <spaces>
-     * <boolean> | e <boolean> ::= "true" | "false" <value-spec-e> ::=
-     * <value-spec> | e <value-spec> ::= ":" <fill> <SAFE-STRING-e> | "::"
-     * <fill> <BASE64-STRING> | ":<" <fill> <url>
-     * 
-     * It can be read as : "control:" <fill> <ldap-oid> [ " "+ ( "true" |
-     * "false") ] [ ":" <fill> <SAFE-STRING-e> | "::" <fill> <BASE64-STRING> | ":<"
-     * <fill> <url> ]
+     * Parse a control. The grammar is : &lt;control&gt; ::= "control:" &lt;fill&gt;
+     * &lt;ldap-oid&gt; &lt;critical-e&gt; &lt;value-spec-e&gt; &lt;sep&gt; &lt;critical-e&gt; ::= &lt;spaces&gt;
+     * &lt;boolean&gt; | e &lt;boolean&gt; ::= "true" | "false" &lt;value-spec-e&gt; ::=
+     * &lt;value-spec&gt; | e &lt;value-spec&gt; ::= ":" &lt;fill&gt; &lt;SAFE-STRING-e&gt; | "::"
+     * &lt;fill&gt; &lt;BASE64-STRING&gt; | ":<" &lt;fill&gt; &lt;url&gt;
+     * 
+     * It can be read as : "control:" &lt;fill&gt; &lt;ldap-oid&gt; [ " "+ ( "true" |
+     * "false") ] [ ":" &lt;fill&gt; &lt;SAFE-STRING-e&gt; | "::" &lt;fill&gt; &lt;BASE64-STRING&gt; | ":<"
+     * &lt;fill&gt; &lt;url&gt; ]
      * 
      * @param line
      *            The line containing the control
@@ -805,12 +804,7 @@
     /**
      * Parse an AttributeType/AttributeValue
      * 
-     * @param attribute
-     *            The create attribute
-     * @param line
-     *            The line to parse
-     * @param lowerLine
-     *            The same line, lowercased
+     * @param line The line to parse
      */
     public static Attribute parseAttributeValue( String line )
     {
@@ -929,13 +923,13 @@
     /**
      * Parse a modify change type.
      * 
-     * The grammar is : <changerecord> ::= "changetype:" FILL "modify" SEP
-     * <mod-spec> <mod-specs-e> <mod-spec> ::= "add:" <mod-val> | "delete:"
-     * <mod-val-del> | "replace:" <mod-val> <mod-specs-e> ::= <mod-spec>
-     * <mod-specs-e> | e <mod-val> ::= FILL ATTRIBUTE-DESCRIPTION SEP
-     * ATTRVAL-SPEC <attrval-specs-e> "-" SEP <mod-val-del> ::= FILL
-     * ATTRIBUTE-DESCRIPTION SEP <attrval-specs-e> "-" SEP <attrval-specs-e> ::=
-     * ATTRVAL-SPEC <attrval-specs> | e *
+     * The grammar is : &lt;changerecord&gt; ::= "changetype:" FILL "modify" SEP
+     * &lt;mod-spec&gt; &lt;mod-specs-e&gt; &lt;mod-spec&gt; ::= "add:" &lt;mod-val&gt; | "delete:"
+     * &lt;mod-val-del&gt; | "replace:" &lt;mod-val&gt; &lt;mod-specs-e&gt; ::= &lt;mod-spec&gt;
+     * &lt;mod-specs-e&gt; | e &lt;mod-val&gt; ::= FILL ATTRIBUTE-DESCRIPTION SEP
+     * ATTRVAL-SPEC &lt;attrval-specs-e&gt; "-" SEP &lt;mod-val-del&gt; ::= FILL
+     * ATTRIBUTE-DESCRIPTION SEP &lt;attrval-specs-e&gt; "-" SEP &lt;attrval-specs-e&gt; ::=
+     * ATTRVAL-SPEC &lt;attrval-specs&gt; | e *
      * 
      * @param entry
      *            The entry to feed
@@ -1060,18 +1054,18 @@
      * "newrdn:" and a "deleteoldrdn:" 4) ModRDN : the very same, but a
      * "newsuperior:" line is expected 5) Modify :
      * 
-     * The grammar is : <changerecord> ::= "changetype:" FILL "add" SEP
-     * <attrval-spec> <attrval-specs-e> | "changetype:" FILL "delete" |
-     * "changetype:" FILL "modrdn" SEP <newrdn> SEP <deleteoldrdn> SEP | // To
-     * be checked "changetype:" FILL "moddn" SEP <newrdn> SEP <deleteoldrdn> SEP
-     * <newsuperior> SEP | "changetype:" FILL "modify" SEP <mod-spec>
-     * <mod-specs-e> <newrdn> ::= "newrdn:" FILL RDN | "newrdn::" FILL
-     * BASE64-RDN <deleteoldrdn> ::= "deleteoldrdn:" FILL "0" | "deleteoldrdn:"
-     * FILL "1" <newsuperior> ::= "newsuperior:" FILL DN | "newsuperior::" FILL
-     * BASE64-DN <mod-specs-e> ::= <mod-spec> <mod-specs-e> | e <mod-spec> ::=
-     * "add:" <mod-val> | "delete:" <mod-val> | "replace:" <mod-val> <mod-val>
-     * ::= FILL ATTRIBUTE-DESCRIPTION SEP ATTRVAL-SPEC <attrval-specs-e> "-" SEP
-     * <attrval-specs-e> ::= ATTRVAL-SPEC <attrval-specs> | e
+     * The grammar is : &lt;changerecord&gt; ::= "changetype:" FILL "add" SEP
+     * &lt;attrval-spec&gt; &lt;attrval-specs-e&gt; | "changetype:" FILL "delete" |
+     * "changetype:" FILL "modrdn" SEP &lt;newrdn&gt; SEP &lt;deleteoldrdn&gt; SEP | // To
+     * be checked "changetype:" FILL "moddn" SEP &lt;newrdn&gt; SEP &lt;deleteoldrdn&gt; SEP
+     * &lt;newsuperior&gt; SEP | "changetype:" FILL "modify" SEP &lt;mod-spec&gt;
+     * &lt;mod-specs-e&gt; &lt;newrdn&gt; ::= "newrdn:" FILL RDN | "newrdn::" FILL
+     * BASE64-RDN &lt;deleteoldrdn&gt; ::= "deleteoldrdn:" FILL "0" | "deleteoldrdn:"
+     * FILL "1" &lt;newsuperior&gt; ::= "newsuperior:" FILL DN | "newsuperior::" FILL
+     * BASE64-DN &lt;mod-specs-e&gt; ::= &lt;mod-spec&gt; &lt;mod-specs-e&gt; | e &lt;mod-spec&gt; ::=
+     * "add:" &lt;mod-val&gt; | "delete:" &lt;mod-val&gt; | "replace:" &lt;mod-val&gt; &lt;mod-val&gt;
+     * ::= FILL ATTRIBUTE-DESCRIPTION SEP ATTRVAL-SPEC &lt;attrval-specs-e&gt; "-" SEP
+     * &lt;attrval-specs-e&gt; ::= ATTRVAL-SPEC &lt;attrval-specs&gt; | e
      * 
      * @param entry
      *            The entry to feed
@@ -1158,12 +1152,12 @@
     /**
      * Parse a ldif file. The following rules are processed :
      * 
-     * <ldif-file> ::= <ldif-attrval-record> <ldif-attrval-records> |
-     * <ldif-change-record> <ldif-change-records> <ldif-attrval-record> ::=
-     * <dn-spec> <sep> <attrval-spec> <attrval-specs> <ldif-change-record> ::=
-     * <dn-spec> <sep> <controls-e> <changerecord> <dn-spec> ::= "dn:" <fill>
-     * <distinguishedName> | "dn::" <fill> <base64-distinguishedName>
-     * <changerecord> ::= "changetype:" <fill> <change-op>
+     * &lt;ldif-file&gt; ::= &lt;ldif-attrval-record&gt; &lt;ldif-attrval-records&gt; |
+     * &lt;ldif-change-record&gt; &lt;ldif-change-records&gt; &lt;ldif-attrval-record&gt; ::=
+     * &lt;dn-spec&gt; &lt;sep&gt; &lt;attrval-spec&gt; &lt;attrval-specs&gt; &lt;ldif-change-record&gt; ::=
+     * &lt;dn-spec&gt; &lt;sep&gt; &lt;controls-e&gt; &lt;changerecord&gt; &lt;dn-spec&gt; ::= "dn:" &lt;fill&gt;
+     * &lt;distinguishedName&gt; | "dn::" &lt;fill&gt; &lt;base64-distinguishedName&gt;
+     * &lt;changerecord&gt; ::= "changetype:" &lt;fill&gt; &lt;change-op&gt;
      */
     private Entry parseEntry() throws NamingException
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/AddRequestImpl.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/AddRequestImpl.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/AddRequestImpl.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/AddRequestImpl.java Wed Nov  1 14:04:34 2006
@@ -102,7 +102,7 @@
     /**
      * Sets the attribute value pairs of the entry to add as a MultiMap.
      * 
-     * @param entry
+     * @param attributes
      *            the Attributes with attribute value pairs for the added entry.
      */
     public void setAttributes( Attributes attributes )

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/CompareRequest.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/CompareRequest.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/CompareRequest.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/CompareRequest.java Wed Nov  1 14:04:34 2006
@@ -51,8 +51,7 @@
      * Sets the distinguished name of the entry to be compared using the
      * attribute value assertion.
      * 
-     * @param a_name
-     *            the DN of the compared entry.
+     * @param name the DN of the compared entry.
      */
     void setName( LdapDN name );
 
@@ -68,17 +67,15 @@
     /**
      * Sets the attribute value to use in the comparison.
      * 
-     * @param a_value
-     *            the attribute value used in comparison.
+     * @param value the attribute value used in comparison.
      */
-    void setAssertionValue( String a_value );
+    void setAssertionValue( String value );
 
 
     /**
      * Sets the attribute value to use in the comparison.
      * 
-     * @param a_value
-     *            the attribute value used in comparison.
+     * @param value the attribute value used in comparison.
      */
     void setAssertionValue( byte[] value );
 
@@ -94,8 +91,7 @@
     /**
      * Sets the attribute id used in the comparison.
      * 
-     * @param a_attrId
-     *            the attribute id used in comparison.
+     * @param attrId the attribute id used in comparison.
      */
-    void setAttributeId( String a_attrId );
+    void setAttributeId( String attrId );
 }

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/DeleteRequest.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/DeleteRequest.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/DeleteRequest.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/DeleteRequest.java Wed Nov  1 14:04:34 2006
@@ -51,8 +51,7 @@
      * Sets the distinguished name of the leaf entry to be deleted by this
      * request.
      * 
-     * @param a_name
-     *            the DN of the leaf entry to delete.
+     * @param name the DN of the leaf entry to delete.
      */
     void setName( LdapDN name );
 }

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LdapResultImpl.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LdapResultImpl.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LdapResultImpl.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LdapResultImpl.java Wed Nov  1 14:04:34 2006
@@ -174,8 +174,8 @@
 
 
     /**
-     * @param obj
-     * @return
+     * @param obj The object to compare with
+     * @return <code>true</code> if both objects are equals
      */
     public boolean equals( Object obj )
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LockableAttributeImpl.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LockableAttributeImpl.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LockableAttributeImpl.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/LockableAttributeImpl.java Wed Nov  1 14:04:34 2006
@@ -542,7 +542,7 @@
      * with regard to case and value order is only considered if the Attribute
      * arguement is ordered itself.
      * 
-     * @todo start looking at comparing syntaxes to determine if attributes are
+     * TODO start looking at comparing syntaxes to determine if attributes are
      *       really equal
      * @param obj
      *            the Attribute to test for equality

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/Referral.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/Referral.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/Referral.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/Referral.java Wed Nov  1 14:04:34 2006
@@ -80,7 +80,7 @@
  * 
  * @author <a href="mailto:dev@directory.apache.org"> Apache Directory Project</a>
  * @version $Rev$
- * @todo This interface should be located in a url package under common to be
+ * TODO This interface should be located in a url package under common to be
  *       constructed from a LDAPv3 URL parser. The interface will eventually
  *       look very different once url support is added: for one it will add and
  *       remove LdapUrl objects instead of strings or provide both string and

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResponseCarryingMessageException.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResponseCarryingMessageException.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResponseCarryingMessageException.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResponseCarryingMessageException.java Wed Nov  1 14:04:34 2006
@@ -55,7 +55,7 @@
     /**
      * Constructs an Exception with a detailed message.
      * 
-     * @param a_message
+     * @param message
      *            The message associated with the exception.
      */
     public ResponseCarryingMessageException(String message)

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResultCodeEnum.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResultCodeEnum.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResultCodeEnum.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/ResultCodeEnum.java Wed Nov  1 14:04:34 2006
@@ -2442,8 +2442,8 @@
      * 
      * If we cannot find a mapping then null is returned.
      * 
-     * @param t
-     * @return
+     * @param t The exception for which we need a ResultCodeEnum
+     * @return The ResultCodeEnum associated wit the given exception 
      */
     public static ResultCodeEnum getResultCode( Throwable t )
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java Wed Nov  1 14:04:34 2006
@@ -44,7 +44,7 @@
      * complete however before then it can return search entry, search
      * reference, and extended responses to the client.
      * 
-     * @see getResponseTypes()
+     * @see #getResponseTypes()
      */
     MessageTypeEnum[] RESPONSE_TYPES =
         { SearchResponseDone.TYPE, SearchResponseEntry.TYPE, SearchResponseReference.TYPE, ExtendedResponse.TYPE };
@@ -54,7 +54,7 @@
      * Gets the different response types generated by a search request.
      * 
      * @return the RESPONSE_TYPES array
-     * @see RESPONSE_TYPES
+     * @see #RESPONSE_TYPES
      */
     MessageTypeEnum[] getResponseTypes();
 
@@ -70,8 +70,7 @@
     /**
      * Sets the search base as a distinguished name.
      * 
-     * @param a_baseDn
-     *            the search base
+     * @param baseDn the search base
      */
     void setBase( LdapDN baseDn );
 
@@ -87,10 +86,9 @@
     /**
      * Sets the search scope parameter enumeration.
      * 
-     * @param a_scope
-     *            the scope enumeration parameter.
+     * @param scope the scope enumeration parameter.
      */
-    void setScope( ScopeEnum a_scope );
+    void setScope( ScopeEnum scope );
 
 
     /**
@@ -104,10 +102,10 @@
     /**
      * Sets the alias handling parameter.
      * 
-     * @param a_derefAliases
+     * @param derefAliases
      *            the alias handling parameter enumeration.
      */
-    void setDerefAliases( DerefAliasesEnum a_derefAliases );
+    void setDerefAliases( DerefAliasesEnum derefAliases );
 
 
     /**
@@ -127,10 +125,10 @@
      * that no client-requested sizelimit restrictions are in effect for the
      * search. Servers may enforce a maximum number of entries to return.
      * 
-     * @param a_entriesMax
+     * @param entriesMax
      *            maximum search result entries to return.
      */
-    void setSizeLimit( int a_entriesMax );
+    void setSizeLimit( int entriesMax );
 
 
     /**
@@ -148,10 +146,10 @@
      * for a search. A value of 0 in this field indicates that no client-
      * requested timelimit restrictions are in effect for the search.
      * 
-     * @param a_secondsMax
+     * @param secondsMax
      *            the search time limit in seconds.
      */
-    void setTimeLimit( int a_secondsMax );
+    void setTimeLimit( int secondsMax );
 
 
     /**
@@ -171,10 +169,10 @@
      * causes only attribute types (no values) to be returned. Setting this
      * field to FALSE causes both attribute types and values to be returned.
      * 
-     * @param a_typesOnly
+     * @param typesOnly
      *            true for only types, false for types and values.
      */
-    void setTypesOnly( boolean a_typesOnly );
+    void setTypesOnly( boolean typesOnly );
 
 
     /**
@@ -188,11 +186,11 @@
     /**
      * Sets the search filter associated with this search request.
      * 
-     * @param a_filter
+     * @param filter
      *            the expression node for the root of the filter expression
      *            tree.
      */
-    void setFilter( ExprNode a_filter );
+    void setFilter( ExprNode filter );
 
 
     /**
@@ -223,17 +221,17 @@
     /**
      * Adds an attribute to the set of entry attributes to return.
      * 
-     * @param a_attribute
+     * @param attribute
      *            the attribute description or identifier.
      */
-    void addAttribute( String a_attribute );
+    void addAttribute( String attribute );
 
 
     /**
      * Removes an attribute to the set of entry attributes to return.
      * 
-     * @param a_attribute
+     * @param attribute
      *            the attribute description or identifier.
      */
-    void removeAttribute( String a_attribute );
+    void removeAttribute( String attribute );
 }

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequestImpl.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequestImpl.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequestImpl.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequestImpl.java Wed Nov  1 14:04:34 2006
@@ -192,7 +192,7 @@
      * Gets the different response types generated by a search request.
      * 
      * @return the RESPONSE_TYPES array
-     * @see RESPONSE_TYPES
+     * @see #RESPONSE_TYPES
      */
     public MessageTypeEnum[] getResponseTypes()
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntry.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntry.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntry.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntry.java Wed Nov  1 14:04:34 2006
@@ -50,8 +50,7 @@
     /**
      * Sets the distinguished name of the entry object returned.
      * 
-     * @param a_dn
-     *            the Dn of the entry returned.
+     * @param dn the Dn of the entry returned.
      */
     void setObjectName( LdapDN dn );
 
@@ -67,8 +66,8 @@
     /**
      * Sets the set of attributes and all their values in a MultiMap.
      * 
-     * @param a_attributes
+     * @param attributes
      *            the set of attributes and all their values
      */
-    void setAttributes( Attributes a_attributes );
+    void setAttributes( Attributes attributes );
 }

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntryImpl.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntryImpl.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntryImpl.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchResponseEntryImpl.java Wed Nov  1 14:04:34 2006
@@ -101,7 +101,7 @@
     /**
      * Sets the distinguished name of the entry object returned.
      * 
-     * @param dn
+     * @param objectName
      *            the Dn of the entry returned.
      */
     public void setObjectName( LdapDN objectName )

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/extended/GracefulDisconnect.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/extended/GracefulDisconnect.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/extended/GracefulDisconnect.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/message/extended/GracefulDisconnect.java Wed Nov  1 14:04:34 2006
@@ -45,7 +45,7 @@
 /**
  * An unsolicited notification, extended response, intended for notifying
  * clients of upcoming disconnection due to intended service windows. Unlike the
- * {@see NoticeOfDisconnect} this response contains additional information about
+ * {@link NoticeOfDisconnect} this response contains additional information about
  * the amount of time the server will be offline and exactly when it intends to
  * shutdown.
  * 

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/LdapDN.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/LdapDN.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/LdapDN.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/LdapDN.java Wed Nov  1 14:04:34 2006
@@ -176,10 +176,9 @@
     * &lt;spaces&gt; &lt;name-component&gt; &lt;name-components&gt; | e <br>
     * </p>
     *
-    * @param bytes
-    *            The byte buffer that contains the DN
-    * @exception A
-    *                InvalidNameException is thrown if the buffer does not
+    * @param upName
+    *            The String that contains the DN
+    * @exception InvalidNameException is thrown if the buffer does not
     *                contains a valid DN.
     */
    public LdapDN( String upName ) throws InvalidNameException
@@ -1019,13 +1018,13 @@
    }
 
    /**
-    * Adds a single component to the end of this name.
+    * Adds a single RDN to the end of this name.
     *
-    * @param comp
-    *            the component to add
+    * @param newRdn
+    *            the RDN to add
     * @return the updated name (not a new one)
     * @throws InvalidNameException
-    *             if adding <tt>comp</tt> would violate the syntax rules of
+    *             if adding <tt>RDN</tt> would violate the syntax rules of
     *             this name
     */
    public Name add( Rdn newRdn ) throws InvalidNameException
@@ -1282,7 +1281,7 @@
     *
     * @param rdn
     *            The RDN to modify
-    * @param oids
+    * @param oidsMap
     *            The map of all existing oids and normalizer
     * @throws InvalidNameException
     *             If
@@ -1369,7 +1368,7 @@
     *
     * @param dn
     *            The DN to transform
-    * @param oids
+    * @param oidsMap
     *            The mapping between names and oids.
     * @return A normalized form of the DN
     * @throws InvalidNameException
@@ -1411,11 +1410,8 @@
     * important do have such a representation, as 'cn' and 'commonname' share
     * the same OID.
     *
-    * @param dn
-    *            The DN to transform
-    * @param oids
+    * @param oidsMap
     *            The mapping between names and oids.
-    * @return A normalized form of the DN
     * @throws InvalidNameException
     *             If the DN is invalid
     */

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/RdnParser.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/RdnParser.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/RdnParser.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/name/RdnParser.java Wed Nov  1 14:04:34 2006
@@ -564,10 +564,9 @@
      * &lt;spaces&gt; &lt;attributeValue&gt; &lt;nameComponents&gt;
      * </p>
      *
-     * @param bytes
-     *            The buffer to parse
-     * @param pos
-     *            The current position in the buffer
+     * @param dn The String to parse
+     * @param pos The current position in the buffer
+     * @param rdn The constructed RDN
      * @return The new position in the char array, or PARSING_ERROR if the rule
      *         does not apply to the char array
      */

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/schema/DescriptionUtils.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/schema/DescriptionUtils.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/schema/DescriptionUtils.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/schema/DescriptionUtils.java Wed Nov  1 14:04:34 2006
@@ -328,8 +328,9 @@
      *      [extensions] describe extensions.
      * </pre>
      * 
-     * @param matchingRuleUse
-     * @return
+     * @param matchingRuleUse The matching rule from which we want to generate
+     *  a MatchingRuleUseDescription.
+     * @return The generated MatchingRuleUseDescription
      */
     public static String getDescription( MatchingRuleUse matchingRuleUse ) throws NamingException
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/subtree/BaseSubtreeSpecification.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/subtree/BaseSubtreeSpecification.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/subtree/BaseSubtreeSpecification.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/subtree/BaseSubtreeSpecification.java Wed Nov  1 14:04:34 2006
@@ -157,7 +157,7 @@
     /**
      * Creates a subtree which may be a refinement filter where all aspects of
      * the specification can be set. If the refinement filter is null this
-     * defaults to {@link #BaseSubtreeSpecification(Name, int, int, Set, Set)}.
+     * defaults to {@link #BaseSubtreeSpecification(LdapDN, int, int, Set, Set)}.
      * 
      * @param base
      *            the base of the subtree relative to the administrative point

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ClassUtils.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ClassUtils.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ClassUtils.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ClassUtils.java Wed Nov  1 14:04:34 2006
@@ -45,7 +45,7 @@
 
     /**
      * <p>
-     * The package separator character: <code>'&#x2e;' == {@}</code>.
+     * The package separator character: <code>'&#x2e;' == .</code>.
      * </p>
      */
     public static final char PACKAGE_SEPARATOR_CHAR = '.';
@@ -59,7 +59,7 @@
 
     /**
      * <p>
-     * The inner class separator character: <code>'$' == {@}</code>.
+     * The inner class separator character: <code>'$' == $</code>.
      * </p>
      */
     public static final char INNER_CLASS_SEPARATOR_CHAR = '$';

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/DNUtils.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/DNUtils.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/DNUtils.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/DNUtils.java Wed Nov  1 14:04:34 2006
@@ -54,7 +54,7 @@
     public static final int TWO_BYTES = 2;
 
     /**
-     * <safe-init-char> ::= [0x01-0x09] | 0x0B | 0x0C | [0x0E-0x1F] |
+     * &lt;safe-init-char&gt; ::= [0x01-0x09] | 0x0B | 0x0C | [0x0E-0x1F] |
      * [0x21-0x39] | 0x3B | [0x3D-0x7F]
      */
     private static final boolean[] SAFE_INIT_CHAR =
@@ -77,7 +77,7 @@
             true,  true,  true,  true,  true,  true,  true,  true 
         };
 
-    /** <safe-char> ::= [0x01-0x09] | 0x0B | 0x0C | [0x0E-0x7F] */
+    /** &lt;safe-char&gt; ::= [0x01-0x09] | 0x0B | 0x0C | [0x0E-0x7F] */
     private static final boolean[] SAFE_CHAR =
         { 
             false, true,  true,  true,  true,  true,  true,  true, 
@@ -99,7 +99,7 @@
         };
 
     /**
-     * <base64-char> ::= 0x2B | 0x2F | [0x30-0x39] | 0x3D | [0x41-0x5A] |
+     * &lt;base64-char&gt; ::= 0x2B | 0x2F | [0x30-0x39] | 0x3D | [0x41-0x5A] |
      * [0x61-0x7A]
      */
     private static final boolean[] BASE64_CHAR =
@@ -193,9 +193,9 @@
 
     /**
      * Walk the buffer while characters are Safe String characters :
-     * <safe-string> ::= <safe-init-char> <safe-chars> <safe-init-char> ::=
+     * &lt;safe-string&gt; ::= &lt;safe-init-char&gt; &lt;safe-chars&gt; &lt;safe-init-char&gt; ::=
      * [0x01-0x09] | 0x0B | 0x0C | [0x0E-0x1F] | [0x21-0x39] | 0x3B |
-     * [0x3D-0x7F] <safe-chars> ::= <safe-char> <safe-chars> | <safe-char> ::=
+     * [0x3D-0x7F] &lt;safe-chars&gt; ::= &lt;safe-char&gt; &lt;safe-chars&gt; | &lt;safe-char&gt; ::=
      * [0x01-0x09] | 0x0B | 0x0C | [0x0E-0x7F]
      * 
      * @param byteArray
@@ -239,7 +239,7 @@
 
 
     /**
-     * Walk the buffer while characters are Alpha characters : <alpha> ::=
+     * Walk the buffer while characters are Alpha characters : &lt;alpha&gt; ::=
      * [0x41-0x5A] | [0x61-0x7A]
      * 
      * @param byteArray
@@ -271,7 +271,7 @@
 
 
     /**
-     * Walk the buffer while characters are Alpha characters : <alpha> ::=
+     * Walk the buffer while characters are Alpha characters : &lt;alpha&gt; ::=
      * [0x41-0x5A] | [0x61-0x7A]
      * 
      * @param charArray
@@ -303,7 +303,7 @@
 
 
     /**
-     * Check if the current character is a Pair Char <pairchar> ::= ',' | '=' |
+     * Check if the current character is a Pair Char &lt;pairchar&gt; ::= ',' | '=' |
      * '+' | '<' | '>' | '#' | ';' | '\' | '"' | [0-9a-fA-F] [0-9a-fA-F]
      * 
      * @param byteArray
@@ -342,7 +342,7 @@
 
 
     /**
-     * Check if the current character is a Pair Char <pairchar> ::= ',' | '=' |
+     * Check if the current character is a Pair Char &lt;pairchar&gt; ::= ',' | '=' |
      * '+' | '<' | '>' | '#' | ';' | '\' | '"' | [0-9a-fA-F] [0-9a-fA-F]
      * 
      * @param charArray
@@ -382,7 +382,7 @@
     /**
      * Check if the current character is a Pair Char 
      * 
-     * <pairchar> ::= ' ' | ',' | '=' | '+' | '<' | '>' | '#' | ';' | 
+     * &lt;pairchar&gt; ::= ' ' | ',' | '=' | '+' | '<' | '>' | '#' | ';' | 
      *                  '\' | '"' | [0-9a-fA-F] [0-9a-fA-F]
      * 
      * @param string
@@ -424,7 +424,7 @@
 
     /**
      * Check if the current character is a String Char. Chars are Unicode, not
-     * ASCII. <stringchar> ::= [0x00-0xFFFF] - [,=+<>#;\"\n\r]
+     * ASCII. &lt;stringchar&gt; ::= [0x00-0xFFFF] - [,=+<>#;\"\n\r]
      * 
      * @param byteArray
      *            The buffer which contains the data
@@ -457,7 +457,7 @@
 
     /**
      * Check if the current character is a String Char. Chars are Unicode, not
-     * ASCII. <stringchar> ::= [0x00-0xFFFF] - [,=+<>#;\"\n\r]
+     * ASCII. &lt;stringchar&gt; ::= [0x00-0xFFFF] - [,=+<>#;\"\n\r]
      * 
      * @param charArray
      *            The buffer which contains the data
@@ -490,7 +490,7 @@
 
     /**
      * Check if the current character is a String Char. Chars are Unicode, not
-     * ASCII. <stringchar> ::= [0x00-0xFFFF] - [,=+<>#;\"\n\r]
+     * ASCII. &lt;stringchar&gt; ::= [0x00-0xFFFF] - [,=+<>#;\"\n\r]
      * 
      * @param string
      *            The string which contains the data
@@ -525,7 +525,7 @@
 
     /**
      * Check if the current character is a Quote Char We are testing Unicode
-     * chars <quotechar> ::= [0x00-0xFFFF] - [\"]
+     * chars &lt;quotechar&gt; ::= [0x00-0xFFFF] - [\"]
      * 
      * @param byteArray The buffer which contains the data
      * @param index Current position in the buffer
@@ -556,7 +556,7 @@
 
     /**
      * Check if the current character is a Quote Char We are testing Unicode
-     * chars <quotechar> ::= [0x00-0xFFFF] - [\"]
+     * chars &lt;quotechar&gt; ::= [0x00-0xFFFF] - [\"]
      * 
      * @param charArray The buffer which contains the data
      * @param index Current position in the buffer
@@ -586,7 +586,7 @@
 
     /**
      * Check if the current character is a Quote Char We are testing Unicode
-     * chars <quotechar> ::= [0x00-0xFFFF] - [\"]
+     * chars &lt;quotechar&gt; ::= [0x00-0xFFFF] - [\"]
      * 
      * @param string The string which contains the data
      * @param index Current position in the string
@@ -618,7 +618,7 @@
 
 
     /**
-     * Parse an hex pair <hexpair> ::= <hex> <hex>
+     * Parse an hex pair &lt;hexpair&gt; ::= &lt;hex&gt; &lt;hex&gt;
      * 
      * @param byteArray
      *            The buffer which contains the data
@@ -648,7 +648,7 @@
 
 
     /**
-     * Parse an hex pair <hexpair> ::= <hex> <hex>
+     * Parse an hex pair &lt;hexpair&gt; ::= &lt;hex&gt; &lt;hex&gt;
      * 
      * @param charArray
      *            The buffer which contains the data
@@ -677,7 +677,7 @@
     }
 
     /**
-     * Parse an hex pair <hexpair> ::= <hex> <hex>
+     * Parse an hex pair &lt;hexpair&gt; ::= &lt;hex&gt; &lt;hex&gt;
      * 
      * @param string
      *            The string which contains the data
@@ -706,7 +706,7 @@
     }
 
     /**
-     * Parse an hex pair <hexpair> ::= <hex> <hex>
+     * Parse an hex pair &lt;hexpair&gt; ::= &lt;hex&gt; &lt;hex&gt;
      * 
      * @param string
      *            The string which contains the data
@@ -722,8 +722,8 @@
     }
 
     /**
-     * Parse an hex string, which is a list of hex pairs <hexstring> ::=
-     * <hexpair> <hexpairs> <hexpairs> ::= <hexpair> <hexpairs> | e
+     * Parse an hex string, which is a list of hex pairs &lt;hexstring&gt; ::=
+     * &lt;hexpair&gt; &lt;hexpairs&gt; &lt;hexpairs&gt; ::= &lt;hexpair&gt; &lt;hexpairs&gt; | e
      * 
      * @param byteArray
      *            The buffer which contains the data
@@ -756,8 +756,8 @@
 
 
     /**
-     * Parse an hex string, which is a list of hex pairs <hexstring> ::=
-     * <hexpair> <hexpairs> <hexpairs> ::= <hexpair> <hexpairs> | e
+     * Parse an hex string, which is a list of hex pairs &lt;hexstring&gt; ::=
+     * &lt;hexpair&gt; &lt;hexpairs&gt; &lt;hexpairs&gt; ::= &lt;hexpair&gt; &lt;hexpairs&gt; | e
      * 
      * @param charArray
      *            The buffer which contains the data
@@ -789,12 +789,12 @@
     }
 
     /**
-     * Parse an hex string, which is a list of hex pairs <hexstring> ::=
-     * <hexpair> <hexpairs> <hexpairs> ::= <hexpair> <hexpairs> | e
+     * Parse an hex string, which is a list of hex pairs &lt;hexstring&gt; ::=
+     * &lt;hexpair&gt; &lt;hexpairs&gt; &lt;hexpairs&gt; ::= &lt;hexpair&gt; &lt;hexpairs&gt; | e
      * 
      * @param string
      *            The string which contains the data
-     * @param index
+     * @param pos
      *            Current position in the string
      * @return Return the first position which is not an hex pair, or -1 if
      *         there is no hexpair at the beginning or if an hexpair is invalid
@@ -823,12 +823,12 @@
     }
 
     /**
-     * Parse an hex string, which is a list of hex pairs <hexstring> ::=
-     * <hexpair> <hexpairs> <hexpairs> ::= <hexpair> <hexpairs> | e
+     * Parse an hex string, which is a list of hex pairs &lt;hexstring&gt; ::=
+     * &lt;hexpair&gt; &lt;hexpairs&gt; &lt;hexpairs&gt; ::= &lt;hexpair&gt; &lt;hexpairs&gt; | e
      * 
      * @param string The string which contains the data
      * @param hex The result as a byte array
-     * @param Position Current position in the string
+     * @param pos Current position in the string
      * @return Return the first position which is not an hex pair, or -1 if
      *         there is no hexpair at the beginning or if an hexpair is invalid
      *         (if we have only one hex instead of 2)
@@ -859,9 +859,9 @@
     }
 
     /**
-     * Walk the buffer while characters are Base64 characters : <base64-string>
-     * ::= <base64-char> <base64-chars> <base64-chars> ::= <base64-char>
-     * <base64-chars> | <base64-char> ::= 0x2B | 0x2F | [0x30-0x39] | 0x3D |
+     * Walk the buffer while characters are Base64 characters : &lt;base64-string&gt;
+     * ::= &lt;base64-char&gt; &lt;base64-chars&gt; &lt;base64-chars&gt; ::= &lt;base64-char&gt;
+     * &lt;base64-chars&gt; | &lt;base64-char&gt; ::= 0x2B | 0x2F | [0x30-0x39] | 0x3D |
      * [0x41-0x5A] | [0x61-0x7A]
      * 
      * @param byteArray

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/NamespaceTools.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/NamespaceTools.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/NamespaceTools.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/NamespaceTools.java Wed Nov  1 14:04:34 2006
@@ -31,7 +31,6 @@
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Revision$
- * @testcase test.ldapdd.util.TestNamespaceTools
  */
 public class NamespaceTools
 {
@@ -137,7 +136,7 @@
      */
 
     /**
-     * @task What is this method for??? It does not make sense out of a Context
+     * TODO What is this method for??? It does not make sense out of a Context
      *       implementation.
      * @param a_name
      *            the potentially federated name to get this namespaces
@@ -158,7 +157,7 @@
     /**
      * Generates the string representation of a name.
      * 
-     * @task what the hell are these functions for if toString on a Name returns
+     * TODO what the hell are these functions for if toString on a Name returns
      *       the string representation for me?
      * @param a_name
      *            the Name object to convert to a string.
@@ -512,9 +511,9 @@
     /**
      * Checks to see if a name has name complex name components in it.
      * 
-     * @param name
-     * @return
-     * @throws NamingException
+     * @param name The name to check 
+     * @return <code>true</code> if the name has composite components
+     * @throws NamingException If the name is invalid
      */
     public static boolean hasCompositeComponents( String name ) throws NamingException
     {

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/Nestable.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/Nestable.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/Nestable.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/Nestable.java Wed Nov  1 14:04:34 2006
@@ -171,8 +171,8 @@
 
     /**
      * Prints the stack trace for this exception only--root cause not
-     * included--using the provided writer. Used by {@link
-     * org.apache.commons.lang.exception.NestableDelegate} to write individual
+     * included--using the provided writer. Used by 
+     * {@link "org.apache.commons.lang.exception.NestableDelegate"} to write individual
      * stack traces to a buffer. The implementation of this method should call
      * <code>super.printStackTrace(out);</code> in most cases.
      * 

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/StringTools.java Wed Nov  1 14:04:34 2006
@@ -81,7 +81,7 @@
 
     private static final int UTF8_SIX_BYTES = 0x00FC;
 
-    /** <alpha> ::= [0x41-0x5A] | [0x61-0x7A] */
+    /** &lt;alpha> ::= [0x41-0x5A] | [0x61-0x7A] */
     public static final boolean[] ALPHA =
         { 
             false, false, false, false, false, false, false, false, 
@@ -102,7 +102,7 @@
             true,  true,  true,  false, false, false, false, false 
         };
 
-    /** <alpha> | <digit> | '-' */
+    /** &lt;alpha> | &lt;digit> | '-' */
     public static final boolean[] CHAR =
         { 
             false, false, false, false, false, false, false, false, 
@@ -144,7 +144,7 @@
             false, false, false, false, false, false, false, false
         };
 
-    /** <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66] */
+    /** &lt;hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66] */
     private static final boolean[] HEX =
         { 
             false, false, false, false, false, false, false, false, 
@@ -164,7 +164,7 @@
             false, false, false, false, false, false, false, false, 
             false, false, false, false, false, false, false, false };
 
-    /** <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66] */
+    /** &lt;hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66] */
     public static final byte[] HEX_VALUE =
         { 
             -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // 00 -> 0F
@@ -323,7 +323,7 @@
      * @return the deep trimmed string
      * @see StringTools#deepTrim( String )
      * 
-     * @TODO Replace the toCharArray() by substrig manipulations
+     * TODO Replace the toCharArray() by substring manipulations
      */
     public static final String deepTrim( String str, boolean toLowerCase )
     {
@@ -498,7 +498,7 @@
      * @param source
      *            the HTML code to be processes
      * @param replaceNl
-     *            if true '\n' will be replaced by <br>
+     *            if true '\n' will be replaced by &lt;br>
      * @param replaceTag
      *            if true '<' will be replaced by &lt; and '>' will be replaced
      *            by &gt;
@@ -799,8 +799,7 @@
     /**
      * Helper function that returns a char from an hex
      * 
-     * @param octet
-     *            The hex to dump
+     * @param hex The hex to dump
      * @return A char representation of the hex
      */
     public static final char dumpHex( byte hex )
@@ -1153,12 +1152,11 @@
      * Return the Unicode char which is coded in the bytes at the given
      * position.
      * 
-     * @param bytes
-     *            The byte[] represntation of an Unicode string.
-     * @param pos
-     *            The current position to start decoding the char
-     * @return The decoded char, or -1 if no char can be decoded TODO : Should
-     *         stop after the third byte, as a char is only 2 bytes long.
+     * @param car The character to be transformed to an array of bytes
+     * 
+     * @return The byte array representing the char 
+     * 
+     * TODO : Should stop after the third byte, as a char is only 2 bytes long.
      */
     public static final byte[] charToBytes( char car )
     {
@@ -1317,7 +1315,7 @@
      *            The string which contains the data
      * @param index
      *            Current position in the string
-     * @param test
+     * @param text
      *            The text we want to check
      * @return <code>true</code> if the string contains the text.
      */
@@ -1479,7 +1477,7 @@
 
 
     /**
-     * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
+     * Check if the current character is an Hex Char &lt;hex> ::= [0x30-0x39] |
      * [0x41-0x46] | [0x61-0x66]
      * 
      * @param byteArray
@@ -1511,7 +1509,7 @@
 
 
     /**
-     * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
+     * Check if the current character is an Hex Char &lt;hex> ::= [0x30-0x39] |
      * [0x41-0x46] | [0x61-0x66]
      * 
      * @param chars
@@ -1542,7 +1540,7 @@
     }
 
     /**
-     * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
+     * Check if the current character is an Hex Char &lt;hex> ::= [0x30-0x39] |
      * [0x41-0x46] | [0x61-0x66]
      * 
      * @param string
@@ -1576,7 +1574,7 @@
     
 
     /**
-     * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+     * Test if the current character is a digit &lt;digit> ::= '0' | '1' | '2' |
      * '3' | '4' | '5' | '6' | '7' | '8' | '9'
      * 
      * @param byteArray
@@ -1596,7 +1594,7 @@
     }
 
     /**
-     * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+     * Test if the current character is a digit &lt;digit> ::= '0' | '1' | '2' |
      * '3' | '4' | '5' | '6' | '7' | '8' | '9'
      * 
      * @param car the character to test
@@ -1610,7 +1608,7 @@
 
 
     /**
-     * Test if the current character is an Alpha character : <alpha> ::=
+     * Test if the current character is an Alpha character : &lt;alpha> ::=
      * [0x41-0x5A] | [0x61-0x7A]
      * 
      * @param byteArray
@@ -1643,7 +1641,7 @@
 
 
     /**
-     * Test if the current character is an Alpha character : <alpha> ::=
+     * Test if the current character is an Alpha character : &lt;alpha> ::=
      * [0x41-0x5A] | [0x61-0x7A]
      * 
      * @param chars
@@ -1675,7 +1673,7 @@
     }
 
     /**
-     * Test if the current character is an Alpha character : <alpha> ::=
+     * Test if the current character is an Alpha character : &lt;alpha> ::=
      * [0x41-0x5A] | [0x61-0x7A]
      * 
      * @param string
@@ -1710,7 +1708,7 @@
 
 
     /**
-     * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+     * Test if the current character is a digit &lt;digit> ::= '0' | '1' | '2' |
      * '3' | '4' | '5' | '6' | '7' | '8' | '9'
      * 
      * @param byteArray
@@ -1733,7 +1731,7 @@
 
 
     /**
-     * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+     * Test if the current character is a digit &lt;digit> ::= '0' | '1' | '2' |
      * '3' | '4' | '5' | '6' | '7' | '8' | '9'
      * 
      * @param chars
@@ -1755,7 +1753,7 @@
     }
 
     /**
-     * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+     * Test if the current character is a digit &lt;digit> ::= '0' | '1' | '2' |
      * '3' | '4' | '5' | '6' | '7' | '8' | '9'
      * 
      * @param string
@@ -1780,7 +1778,7 @@
     }
 
     /**
-     * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+     * Test if the current character is a digit &lt;digit> ::= '0' | '1' | '2' |
      * '3' | '4' | '5' | '6' | '7' | '8' | '9'
      * 
      * @param chars
@@ -1802,7 +1800,7 @@
 
     /**
      * Check if the current character is an 7 bits ASCII CHAR (between 0 and
-     * 127). <char> ::= <alpha> | <digit> | '-'
+     * 127). &lt;char> ::= &lt;alpha> | &lt;digit> | '-'
      * 
      * @param byteArray
      *            The buffer which contains the data
@@ -1834,7 +1832,7 @@
 
     /**
      * Check if the current character is an 7 bits ASCII CHAR (between 0 and
-     * 127). <char> ::= <alpha> | <digit> | '-'
+     * 127). &lt;char> ::= &lt;alpha> | &lt;digit> | '-'
      * 
      * @param chars
      *            The buffer which contains the data
@@ -1865,7 +1863,7 @@
 
     /**
      * Check if the current character is an 7 bits ASCII CHAR (between 0 and
-     * 127). <char> ::= <alpha> | <digit> | '-'
+     * 127). &lt;char> ::= &lt;alpha> | &lt;digit> | '-'
      * 
      * @param string
      *            The string which contains the data
@@ -2002,9 +2000,9 @@
      *  StringUtils.trim(&quot;    abc    &quot;) = &quot;abc&quot;
      * </pre>
      * 
-     * @param str
-     *            the String to be trimmed, may be null
-     * @return the trimmed string, <code>null</code> if null String input
+     * @param bytes the byte array to be trimmed, may be null
+     * 
+     * @return the trimmed byte array
      */
     public static final byte[] trim( byte[] bytes )
     {
@@ -2108,23 +2106,21 @@
 
     /**
      * <p>
-     * Removes spaces (char &lt;= 32) from start of this array, handling
+     * Removes spaces (char &lt;= 32) from a position in this array, handling
      * <code>null</code> by returning <code>null</code>.
      * </p>
      * Trim removes start characters &lt;= 32.
      * 
      * <pre>
      *  StringUtils.trimLeft(null)          = null
-     *  StringUtils.trimLeft(&quot;&quot;)            = &quot;&quot;
-     *  StringUtils.trimLeft(&quot;     &quot;)       = &quot;&quot;
-     *  StringUtils.trimLeft(&quot;abc&quot;)         = &quot;abc&quot;
-     *  StringUtils.trimLeft(&quot;    abc    &quot;) = &quot;abc    &quot;
+     *  StringUtils.trimLeft(&quot;&quot;,...)            = &quot;&quot;
+     *  StringUtils.trimLeft(&quot;     &quot;,...)       = &quot;&quot;
+     *  StringUtils.trimLeft(&quot;abc&quot;,...)         = &quot;abc&quot;
+     *  StringUtils.trimLeft(&quot;    abc    &quot;,...) = &quot;abc    &quot;
      * </pre>
      * 
-     * @param string
-     *            the string to be trimmed, may be null
-     * @return the position of the first char which is not a space, or the last
-     *         position of the array.
+     * @param string the string to be trimmed, may be null
+     * @param pos The starting position
      */
     public static final void trimLeft( String string, Position pos )
     {
@@ -2753,7 +2749,6 @@
      * String is returned.
      * 
      * @param str the string containing hex escapes
-     * @param index the index at which we start decoding
      * @return decoded string
      */
     public static final String decodeEscapedHex( String str ) throws InvalidNameException

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ToStringStyle.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ToStringStyle.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ToStringStyle.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ToStringStyle.java Wed Nov  1 14:04:34 2006
@@ -34,7 +34,7 @@
  * <p>
  * These classes are intended to be used as <code>Singletons</code>. There is
  * no need to instantiate a new style each time. A program will generally use
- * one of the predefined constants on this class. Alternatively, the {@link }
+ * one of the predefined constants on this class. Alternatively, the
  * class can be used to set the individual settings. Thus most styles can be
  * achieved without subclassing.
  * </p>

Modified: directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ValuedEnum.java
URL: http://svn.apache.org/viewvc/directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ValuedEnum.java?view=diff&rev=470116&r1=470115&r2=470116
==============================================================================
--- directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ValuedEnum.java (original)
+++ directory/trunks/shared/ldap/src/main/java/org/apache/directory/shared/ldap/util/ValuedEnum.java Wed Nov  1 14:04:34 2006
@@ -124,7 +124,7 @@
  * <p>
  * The <code>getEnum</code> and <code>iterator</code> methods are
  * recommended. Unfortunately, Java restrictions require these to be coded as
- * shown in each subclass. An alternative choice is to use the {@link } class.
+ * shown in each subclass.
  * </p>
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>



Mime
View raw message