You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by fe...@apache.org on 2010/09/24 12:21:11 UTC
svn commit: r1000793 - in /directory/shared/trunk:
dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/
dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/
i18n/src/main/java/org/apache/directory/shared/i18n/ ldap-client-api/...
Author: felixk
Date: Fri Sep 24 10:21:10 2010
New Revision: 1000793
URL: http://svn.apache.org/viewvc?rev=1000793&view=rev
Log:
Fix some javadoc issues, mostly wrong formatting (@see not at the end in the 'annotations' section) or incomplete use of <li>
Modified:
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Tag.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java
directory/shared/trunk/i18n/src/main/java/org/apache/directory/shared/i18n/I18n.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/SaslRequest.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/BindListener.java
directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/IntermediateResponseListener.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntry.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntryAttribute.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/ImmutableEntry.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/StringValue.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AndNode.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/BranchNode.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/FilterParserMonitorAdapter.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/LeafNode.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/OrNode.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SimpleNode.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/AVA.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/RDN.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/AttributeType.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/ActionTime.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/LdapOperation.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureLanguageSchemeOption.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureParameter.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureSearchContextOption.java
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Tag.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Tag.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Tag.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Tag.java Fri Sep 24 10:21:10 2010
@@ -23,6 +23,7 @@ package org.apache.directory.shared.dsml
/**
* This class represents a XML tag.
+ * <br/>
* A XML tag is defined with :
* <ul>
* <li>a name</li>
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java Fri Sep 24 10:21:10 2010
@@ -29,8 +29,8 @@ import org.dom4j.Element;
/**
- * Class representing Error Response. <br>
- * <br>
+ * Class representing Error Response.
+ * <br/>
* An Error Response has a requestID, a message, and a type which can be :
* <ul>
* <li>NOT_ATTEMPTED,</li>
@@ -223,7 +223,7 @@ public class ErrorResponse extends Abstr
/**
* Gets the type of error response
*
- * @returnvthe type of error response
+ * @return the type of error response
*/
public ErrorResponseType getErrorType()
{
Modified: directory/shared/trunk/i18n/src/main/java/org/apache/directory/shared/i18n/I18n.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/i18n/src/main/java/org/apache/directory/shared/i18n/I18n.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/i18n/src/main/java/org/apache/directory/shared/i18n/I18n.java (original)
+++ directory/shared/trunk/i18n/src/main/java/org/apache/directory/shared/i18n/I18n.java Fri Sep 24 10:21:10 2010
@@ -784,7 +784,7 @@ public enum I18n
}
/**
- * <p>Getter for the field <code>errorCode</code>.</p>
+ * Getter for the field <code>errorCode</code>.
*
* @return the errorCode
* @since 0.9.20
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java Fri Sep 24 10:21:10 2010
@@ -52,7 +52,7 @@ public interface LdapAsyncConnection ext
* the user has to get for the response from the returned Future.
*
* @param entry The entry to add
- * @result the add operation's Future
+ * @return the add operation's Future
*/
AddFuture addAsync( Entry entry ) throws LdapException;
@@ -119,8 +119,9 @@ public interface LdapAsyncConnection ext
*
* @param baseDn The base for the search. It must be a valid
* DN, and can't be emtpy
- * @param filterString The filter to use for this search. It can't be empty
- * @param scope The sarch scope : OBJECT, ONELEVEL or SUBTREE
+ * @param filter The filter to use for this search. It can't be empty
+ * @param scope The search scope : OBJECT, ONELEVEL or SUBTREE
+ * @param attributes The attributes for this search
* @return A cursor on the result.
*/
SearchFuture searchAsync( String baseDn, String filter, SearchScope scope, String... attributes )
@@ -140,8 +141,9 @@ public interface LdapAsyncConnection ext
*
* @param baseDn The base for the search. It must be a valid
* DN, and can't be emtpy
- * @param filterString The filter to use for this search. It can't be empty
- * @param scope The sarch scope : OBJECT, ONELEVEL or SUBTREE
+ * @param filter The filter to use for this search. It can't be empty
+ * @param scope The search scope : OBJECT, ONELEVEL or SUBTREE
+ * @param attributes The attributes for this search
* @return A cursor on the result.
*/
SearchFuture searchAsync( DN baseDn, String filter, SearchScope scope, String... attributes )
@@ -181,7 +183,6 @@ public interface LdapAsyncConnection ext
* performs the modifyDn operation based on the given ModifyDnRequest.
*
* @param modDnRequest the request
- * @param listener callback listener which will be called after the operation is completed
* @return modifyDn operations response, null if non-null listener is provided
* @throws LdapException
*/
@@ -221,7 +222,7 @@ public interface LdapAsyncConnection ext
/**
* configuration of LdapNetworkConnection
*
- * @return
+ * @return the configuration of the ldap connection
*/
LdapConnectionConfig getConfig();
}
\ No newline at end of file
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java Fri Sep 24 10:21:10 2010
@@ -103,7 +103,7 @@ public interface LdapConnection
* to wait for the response until the AddResponse is returned.
*
* @param entry The entry to add
- * @result the add operation's response
+ * @return the add operation's response
* @throws LdapException if some error occurred
*/
public abstract AddResponse add( Entry entry ) throws LdapException;
@@ -201,8 +201,9 @@ public interface LdapConnection
*
* @param baseDn The base for the search. It must be a valid
* DN, and can't be emtpy
- * @param filterString The filter to use for this search. It can't be empty
- * @param scope The sarch scope : OBJECT, ONELEVEL or SUBTREE
+ * @param filter The filter to use for this search. It can't be empty
+ * @param scope The search scope : OBJECT, ONELEVEL or SUBTREE
+ * @param attributes The attributes to use for this search
* @return A cursor on the result.
* @throws LdapException if some error occurred
*/
@@ -223,8 +224,9 @@ public interface LdapConnection
*
* @param baseDn The base for the search. It must be a valid
* DN, and can't be emtpy
- * @param filterString The filter to use for this search. It can't be empty
+ * @param filter The filter to use for this search. It can't be empty
* @param scope The search scope : OBJECT, ONELEVEL or SUBTREE
+ * @param attributes The attributes to use for this search
* @return A cursor on the result.
* @throws LdapException if some error occurred
*/
@@ -265,7 +267,7 @@ public interface LdapConnection
*
* Applies all the modifications to the entry specified by its DN
*
- * @param DN The entry's DN
+ * @param dn The entry's DN
* @param modifications The list of modifications to be applied
* @return the modify operation's response
* @throws LdapException in case of modify operation failure or timeout happens
@@ -277,7 +279,7 @@ public interface LdapConnection
*
* Applies all the modifications to the entry specified by its DN
*
- * @param DN The entry's DN
+ * @param dn The entry's DN
* @param modifications The list of modifications to be applied
* @return the modify operation's response
* @throws LdapException in case of modify operation failure or timeout happens
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionPool.java Fri Sep 24 10:21:10 2010
@@ -52,7 +52,7 @@ public class LdapConnectionPool extends
/**
- * {@inheritDoc}
+ * @see org.apache.commons.pool.impl.GenericObjectPool#setFactory(PoolableObjectFactory factory)
*/
public void setFactory( PoolableLdapConnectionFactory factory )
{
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/SaslRequest.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/SaslRequest.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/SaslRequest.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/SaslRequest.java Fri Sep 24 10:21:10 2010
@@ -51,7 +51,7 @@ public class SaslRequest
/**
* Creates a new instance of SaslRequest.
*
- * @param bindReq The included BindRequest
+ * @param bindRequest The included BindRequest
*/
protected SaslRequest( BindRequest bindRequest )
{
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/BindListener.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/BindListener.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/BindListener.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/BindListener.java Fri Sep 24 10:21:10 2010
@@ -39,7 +39,7 @@ public interface BindListener extends Op
* A callback method called when the bind operation completed.
*
* @param connection
- * @param BindResponseCodec The bind response
+ * @param bindResponse The bind response
*/
void bindCompleted( LdapAsyncConnection connection, BindResponse bindResponse ) throws LdapException;
}
Modified: directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/IntermediateResponseListener.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/IntermediateResponseListener.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/IntermediateResponseListener.java (original)
+++ directory/shared/trunk/ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/listener/IntermediateResponseListener.java Fri Sep 24 10:21:10 2010
@@ -35,7 +35,7 @@ public interface IntermediateResponseLis
* A callback method for each entry returned by a intermediateResponse response.
*
* @param connection The current connection
- * @param IntermediateResponse The intermediate response
+ * @param intermediateResponse The intermediate response
*/
void responseReceived( LdapAsyncConnection connection, IntermediateResponse intermediateResponse );
}
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntry.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntry.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntry.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntry.java Fri Sep 24 10:21:10 2010
@@ -2521,21 +2521,23 @@ public class DefaultEntry implements Ent
/**
- * @see Externalizable#writeExternal(ObjectOutput)<p>
- *
* This is the place where we serialize entries, and all theirs
* elements.
- * <p>
+ * <br/>
* The structure used to store the entry is the following :
- * <li>
- * <b>[DN]</b> : If it's null, stores an empty DN
- * </li>
- * <li>
- * <b>[attributes number]</b> : the number of attributes.
- * </li>
- * <li>
- * <b>[attribute]*</b> : each attribute, if we have some
- * </li>
+ * <ul>
+ * <li>
+ * <b>[DN]</b> : If it's null, stores an empty DN
+ * </li>
+ * <li>
+ * <b>[attributes number]</b> : the number of attributes.
+ * </li>
+ * <li>
+ * <b>[attribute]*</b> : each attribute, if we have some
+ * </li>
+ * </ul>
+ *
+ * @see Externalizable#writeExternal(ObjectOutput)
*/
public void writeExternal( ObjectOutput out ) throws IOException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntryAttribute.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntryAttribute.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntryAttribute.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/DefaultEntryAttribute.java Fri Sep 24 10:21:10 2010
@@ -2390,18 +2390,14 @@ public class DefaultEntryAttribute imple
}
-
-
/**
- * @see Externalizable#writeExternal(ObjectOutput)
- * <p>
- *
* This is the place where we serialize attributes, and all theirs
* elements.
*
* The inner structure is the same as the client attribute, but we can't call
* it as we won't be able to serialize the serverValues
*
+ * @see Externalizable#writeExternal(ObjectOutput)
*/
public void serialize( ObjectOutput out ) throws IOException
{
@@ -2496,14 +2492,12 @@ public class DefaultEntryAttribute imple
/**
- * @see Externalizable#writeExternal(ObjectOutput)
- * <p>
- *
* This is the place where we serialize attributes, and all theirs
* elements.
*
* The inner structure is :
*
+ * @see Externalizable#writeExternal(ObjectOutput)
*/
public void writeExternal( ObjectOutput out ) throws IOException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/ImmutableEntry.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/ImmutableEntry.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/ImmutableEntry.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/ImmutableEntry.java Fri Sep 24 10:21:10 2010
@@ -658,21 +658,23 @@ public class ImmutableEntry implements E
/**
- * @see Externalizable#writeExternal(ObjectOutput)<p>
- *
* This is the place where we serialize entries, and all theirs
* elements.
- * <p>
+ * <br/>
* The structure used to store the entry is the following :
- * <li>
- * <b>[DN]</b> : If it's null, stores an empty DN
- * </li>
- * <li>
- * <b>[attributes number]</b> : the number of attributes.
- * </li>
- * <li>
- * <b>[attribute]*</b> : each attribute, if we have some
- * </li>
+ * <ul>
+ * <li>
+ * <b>[DN]</b> : If it's null, stores an empty DN
+ * </li>
+ * <li>
+ * <b>[attributes number]</b> : the number of attributes.
+ * </li>
+ * <li>
+ * <b>[attribute]*</b> : each attribute, if we have some
+ * </li>
+ * </ul>
+ *
+ * @see Externalizable#writeExternal(ObjectOutput)
*/
public void writeExternal( ObjectOutput out ) throws IOException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/StringValue.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/StringValue.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/StringValue.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/entry/StringValue.java Fri Sep 24 10:21:10 2010
@@ -350,9 +350,9 @@ public class StringValue extends Abstrac
/**
- * @see Object#equals(Object)
- *
* Two StringValue are equals if their normalized values are equal
+ *
+ * @see Object#equals(Object)
*/
public boolean equals( Object obj )
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AndNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AndNode.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AndNode.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/AndNode.java Fri Sep 24 10:21:10 2010
@@ -174,9 +174,7 @@ public class AndNode extends BranchNode
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object other )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/BranchNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/BranchNode.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/BranchNode.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/BranchNode.java Fri Sep 24 10:21:10 2010
@@ -230,8 +230,6 @@ public class BranchNode extends Abstract
/**
- * (non-Javadoc)
- *
* @see Object#hashCode()
* @return the instance's hash code
*/
@@ -252,9 +250,7 @@ public class BranchNode extends Abstract
return h;
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object other )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/FilterParserMonitorAdapter.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/FilterParserMonitorAdapter.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/FilterParserMonitorAdapter.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/FilterParserMonitorAdapter.java Fri Sep 24 10:21:10 2010
@@ -27,9 +27,7 @@ package org.apache.directory.shared.ldap
*/
public class FilterParserMonitorAdapter implements FilterParserMonitor
{
- /*
- * (non-Javadoc)
- *
+ /**
* @see org.apache.ldap.common.filter.FilterParserMonitor#
* matchedProduction(java.lang.String)
*/
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/LeafNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/LeafNode.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/LeafNode.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/LeafNode.java Fri Sep 24 10:21:10 2010
@@ -175,9 +175,7 @@ public class LeafNode extends AbstractEx
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object other )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/OrNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/OrNode.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/OrNode.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/OrNode.java Fri Sep 24 10:21:10 2010
@@ -174,9 +174,7 @@ public class OrNode extends BranchNode
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object other )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SimpleNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SimpleNode.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SimpleNode.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/filter/SimpleNode.java Fri Sep 24 10:21:10 2010
@@ -187,9 +187,7 @@ public abstract class SimpleNode<T> exte
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object other )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/AVA.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/AVA.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/AVA.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/AVA.java Fri Sep 24 10:21:10 2010
@@ -686,27 +686,57 @@ public class AVA implements Cloneable, C
/**
- * @see Externalizable#readExternal(ObjectInput)<p>
*
* An AVA is composed of a type and a value.
* The data are stored following the structure :
- *
- * <li>upName</li> The User provided ATAV
- * <li>start</li> The position of this ATAV in the DN
- * <li>length</li> The ATAV length
- * <li>upType</li> The user Provided Type
- * <li>normType</li> The normalized AttributeType
- * <li>isHR<li> Tells if the value is a String or not
- * <p>
+ * <ul>
+ * <li>
+ * <b>upName</b> The User provided ATAV
+ * </li>
+ * <li>
+ * <b/>start</b> The position of this ATAV in the DN
+ * </li>
+ * <li>
+ * <b>length</b> The ATAV length
+ * </li>
+ * <li>
+ * <b>upType</b> The user Provided Type
+ * </li>
+ * <li>
+ * <b>normType</b> The normalized AttributeType
+ * </li>
+ * <li>
+ * <b>isHR</b> Tells if the value is a String or not
+ * </li>
+ * </ul>
+ * <br/>
* if the value is a String :
- * <li>upValue</li> The User Provided value.
- * <li>value</li> The normalized value.
- * <p>
+ * <ul>
+ * <li>
+ * <b>upValue</b> The User Provided value
+ * </li>
+ * <li>
+ * <b>value</b> The normalized value
+ * </li>
+ * </ul>
+ * <br/>
* if the value is binary :
- * <li>upValueLength</li>
- * <li>upValue</li> The User Provided value.
- * <li>valueLength</li>
- * <li>value</li> The normalized value.
+ * <ul>
+ * <li>
+ * <b>upValueLength</b>
+ * </li>
+ * <li>
+ * <b>upValue</b> The User Provided value
+ * </li>
+ * <li>
+ * <b>valueLength</b>
+ * </li>
+ * <li>
+ * <b>value</b> The normalized value
+ * </li>
+ * </ul>
+ *
+ * @see Externalizable#readExternal(ObjectInput)
*/
public void writeExternal( ObjectOutput out ) throws IOException
{
@@ -779,11 +809,11 @@ public class AVA implements Cloneable, C
/**
- * @see Externalizable#readExternal(ObjectInput)
- *
* We read back the data to create a new ATAV. The structure
* read is exposed in the {@link AVA#writeExternal(ObjectOutput)}
- * method<p>
+ * method
+ *
+ * @see Externalizable#readExternal(ObjectInput)
*/
public void readExternal( ObjectInput in ) throws IOException, ClassNotFoundException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/RDN.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/RDN.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/RDN.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/name/RDN.java Fri Sep 24 10:21:10 2010
@@ -1473,24 +1473,42 @@ public class RDN implements Cloneable, C
/**
- * @see Externalizable#readExternal(ObjectInput)<p>
- *
* A RDN is composed of on to many ATAVs (AttributeType And Value).
* We should write all those ATAVs sequencially, following the
* structure :
- *
- * <li>parentId</li> The parent entry's Id
- * <li>nbAtavs</li> The number of ATAVs to write. Can't be 0.
- * <li>upName</li> The User provided RDN
- * <li>normName</li> The normalized RDN. It can be empty if the normalized
+ * <ul>
+ * <li>
+ * <b>parentId</b> The parent entry's Id
+ * </li>
+ * <li>
+ * <b>nbAtavs</b> The number of ATAVs to write. Can't be 0.
+ * </li>
+ * <li>
+ * <b>upName</b> The User provided RDN
+ * </li>
+ * <li>
+ * <b>normName</b> The normalized RDN. It can be empty if the normalized
* name equals the upName.
- * <li>atavs</li>
- * <p>
- * For each ATAV :<p>
- * <li>start</li> The position of this ATAV in the upName string
- * <li>length</li> The ATAV user provided length
- * <li>Call the ATAV write method</li> The ATAV itself
+ * </li>
+ * <li>
+ * <b>atavs</b>
+ * </li>
+ * </ul>
+ * <br/>
+ * For each ATAV :
+ * <ul>
+ * <li>
+ * <b>start</b> The position of this ATAV in the upName string
+ * </li>
+ * <li>
+ * <b>length</b> The ATAV user provided length
+ * </li>
+ * <li>
+ * <b>Call the ATAV write method</b> The ATAV itself
+ * </li>
+ * </ul>
*
+ * @see Externalizable#readExternal(ObjectInput)
* @param out The stream into which the serialized RDN will be put
* @throws IOException If the stream can't be written
*/
@@ -1532,12 +1550,11 @@ public class RDN implements Cloneable, C
/**
- * @see Externalizable#readExternal(ObjectInput)
- *
* We read back the data to create a new RDB. The structure
* read is exposed in the {@link RDN#writeExternal(ObjectOutput)}
- * method<p>
+ * method
*
+ * @see Externalizable#readExternal(ObjectInput)
* @param in The input stream from which the RDN will be read
* @throws IOException If we can't read from the input stream
* @throws ClassNotFoundException If we can't create a new RDN
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/AttributeType.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/AttributeType.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/AttributeType.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/AttributeType.java Fri Sep 24 10:21:10 2010
@@ -855,12 +855,14 @@ public class AttributeType extends Abstr
/**
- * Sets the AttributeType usage, one of :<br>
- * <li>USER_APPLICATIONS
- * <li>DIRECTORY_OPERATION
- * <li>DISTRIBUTED_OPERATION
- * <li>DSA_OPERATION
- * <br>
+ * Sets the AttributeType usage, one of :
+ * <ul>
+ * <li>USER_APPLICATIONS</li>
+ * <li>DIRECTORY_OPERATION</li>
+ * <li>DISTRIBUTED_OPERATION</li>
+ * <li>DSA_OPERATION</li>
+ * </ul>
+ *
* @see UsageEnum
* @param usage The AttributeType usage
*/
@@ -879,12 +881,14 @@ public class AttributeType extends Abstr
/**
- * Updates the AttributeType usage, one of :<br>
- * <li>USER_APPLICATIONS
- * <li>DIRECTORY_OPERATION
- * <li>DISTRIBUTED_OPERATION
- * <li>DSA_OPERATION
- * <br>
+ * Updates the AttributeType usage, one of :
+ * <ul>
+ * <li>USER_APPLICATIONS</li>
+ * <li>DIRECTORY_OPERATION</li>
+ * <li>DISTRIBUTED_OPERATION</li>
+ * <li>DSA_OPERATION</li>
+ * </ul>
+ *
* @see UsageEnum
* @param usage The AttributeType usage
*/
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/ActionTime.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/ActionTime.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/ActionTime.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/ActionTime.java Fri Sep 24 10:21:10 2010
@@ -54,7 +54,7 @@ public class ActionTime
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Object#toString()
*/
public String toString()
@@ -76,7 +76,7 @@ public class ActionTime
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object obj )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/LdapOperation.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/LdapOperation.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/LdapOperation.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/LdapOperation.java Fri Sep 24 10:21:10 2010
@@ -81,7 +81,7 @@ public class LdapOperation
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object obj )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureLanguageSchemeOption.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureLanguageSchemeOption.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureLanguageSchemeOption.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureLanguageSchemeOption.java Fri Sep 24 10:21:10 2010
@@ -41,7 +41,7 @@ public class StoredProcedureLanguageSche
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Object#toString()
*/
public String toString()
@@ -62,7 +62,7 @@ public class StoredProcedureLanguageSche
return h;
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object obj )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureParameter.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureParameter.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureParameter.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureParameter.java Fri Sep 24 10:21:10 2010
@@ -112,7 +112,7 @@ public abstract class StoredProcedurePar
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object obj )
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureSearchContextOption.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureSearchContextOption.java?rev=1000793&r1=1000792&r2=1000793&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureSearchContextOption.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/trigger/StoredProcedureSearchContextOption.java Fri Sep 24 10:21:10 2010
@@ -76,7 +76,7 @@ public class StoredProcedureSearchContex
return h;
}
- /* (non-Javadoc)
+ /**
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals( Object obj )