Skip to content

Commit dbf5eeb

Browse files
committed
Fixed some javadoc errors
1 parent 62a82d3 commit dbf5eeb

5 files changed

Lines changed: 21 additions & 9 deletions

File tree

ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/TriggerSpecificationModifier.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public TriggerSpecification create()
6464
/**
6565
* Sets the action time.
6666
*
67-
* @param the action time
67+
* @param actionTime the action time
6868
*/
6969
public void setActionTime( ActionTime actionTime )
7070
{
@@ -75,7 +75,7 @@ public void setActionTime( ActionTime actionTime )
7575
/**
7676
* Sets the LDAP operation.
7777
*
78-
* @param the LDAP operation
78+
* @param ldapOperation the LDAP operation
7979
*/
8080
public void setLdapOperation( LdapOperation ldapOperation )
8181
{
@@ -86,7 +86,7 @@ public void setLdapOperation( LdapOperation ldapOperation )
8686
/**
8787
* Add a stored procedure spec.
8888
*
89-
* @param the stored procedure spec to add
89+
* @param spSpec the stored procedure spec to add
9090
*/
9191
public void addSPSpec( SPSpec spSpec )
9292
{
@@ -117,7 +117,7 @@ public SPSpecModifier()
117117
/**
118118
* Set the name.
119119
*
120-
* @param the name
120+
* @param name the name
121121
*/
122122
public void setName( String name )
123123
{
@@ -147,6 +147,11 @@ public void addParameter( StoredProcedureParameter parameter )
147147
}
148148

149149

150+
/**
151+
* Generate a new SPSpec based on the name, options and parameters
152+
*
153+
* @return A new SPSpecs
154+
*/
150155
public SPSpec getSPSpec()
151156
{
152157
return new SPSpec( name, options, parameters );

ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/SubtreeSpecificationParser.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@
9696
* and = ID_and ( SP )* COLON ( SP )* refinements
9797
* or = ID_or ( SP )* COLON ( SP )* refinements
9898
* not = ID_not ( SP )* COLON ( SP )* refinement
99-
* [FILTER = '(' ( '&' (SP)* FILTER+ | '|' (SP)* FILTER+ | '!' (SP)* FILTER | FILTER_VALUE ) ')' (SP)*
100-
* FILTER_VALUE = every char but '(', ')', '&', '|', '!']
99+
* [FILTER = '(' ( '&' (SP)* FILTER+ | '|' (SP)* FILTER+ | '!' (SP)* FILTER | FILTER_VALUE ) ')' (SP)*
100+
* FILTER_VALUE = every char but '(', ')', '&', '|', '!']
101101
* </pre>
102102
*
103103
* Note: the 'filter' part is not present in RFC 3672

ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaParser.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -959,7 +959,7 @@ private SchemaElement parseSchemaElement( String schema, Position pos ) throws P
959959
/**
960960
* Parses an OpenLDAP schemaObject elements/objects.
961961
*
962-
* @param SchemaStr a LDAP schema to parse
962+
* @param schemaStr As LDAP schema to parse
963963
* @return A list of schema elements
964964
* @throws ParseException If we weren't able to parse the schema
965965
*/

util/src/main/java/org/apache/directory/api/util/ParserUtil.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,6 @@ public static boolean isMatchChar( String str, char c, Position pos )
278278
* Check if a specific character is present at the current position in the string.
279279
* If the character is found, the position will be moved forward.
280280
*
281-
* @param bytes The byte[] to process
282281
* @param c The expected character
283282
* @param pos The current position in the string
284283
* @return <code>true</code> if the character is present at the current position,
@@ -312,7 +311,7 @@ public static boolean isMatchChar( byte c, Position pos )
312311
* @param pos The current position in the string
313312
* @return The parsed NumericOid
314313
*/
315-
public static String parseNumericOid( String str, Position pos ) throws ParseException
314+
public static String parseNumericOid( String str, Position pos )
316315
{
317316
int start = pos.start;
318317

util/src/main/java/org/apache/directory/api/util/Position.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ public Position()
5454

5555
/**
5656
* A public constructor
57+
*
58+
* @param text The String to parse
5759
*/
5860
public Position( String text )
5961
{
@@ -63,6 +65,8 @@ public Position( String text )
6365

6466
/**
6567
* A public constructor
68+
*
69+
* @param bytes The bytes to parse
6670
*/
6771
public Position( byte[] bytes )
6872
{
@@ -71,6 +75,8 @@ public Position( byte[] bytes )
7175

7276

7377
/**
78+
* Get the byte at the current position
79+
*
7480
* @return the byte at the current position
7581
*/
7682
public byte getByte()
@@ -80,6 +86,8 @@ public byte getByte()
8086

8187

8288
/**
89+
* Get the stored bytes
90+
*
8391
* @return The interned byte[]
8492
*/
8593
public byte[] getBytes()

0 commit comments

Comments
 (0)