Skip to content

Commit

Permalink
Javadoc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Jul 12, 2023
1 parent 3276e2a commit bf031a5
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/jexl3/JexlArithmetic.java
Original file line number Diff line number Diff line change
Expand Up @@ -801,7 +801,7 @@ public boolean isStrict() {
* If null-safe (ie not-strict), the operator does accept null arguments even if the arithmetic itself is strict.</p>
* <p>The default implementation considers equal/not-equal operators as null-safe so one can check for null as in
* <code>if (myvar == null) {...}</code>. Note that this operator is used for equal and not-equal syntax. The complete
* list of operators that are not strict are (==, [], []=, ., .=, empty, size, contains). </p>
* list of operators that are not strict are (==, [], []=, ., .=, empty, size, contains).</p>
* <p>An arithmetic refining its strict behavior handling for more operators must declare which by overriding
* this method.</p>
* @param operator the operator to check for null-argument(s) handling
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/org/apache/commons/jexl3/JexlEngine.java
Original file line number Diff line number Diff line change
Expand Up @@ -520,8 +520,11 @@ public final JexlScript createScript(final JexlInfo info, final URL scriptUrl, f
public abstract void setProperty(Object bean, String expr, Object value);

/**
* Assign properties of a bean using an expression. <p> If the JEXL engine is silent, errors will be logged through
* its logger as warning. </p>
* Assign properties of a bean using an expression.
* <p>
* If the JEXL engine is silent, errors will be logged through
* its logger as warning.
* </p>
*
* @param context the evaluation context
* @param bean the bean to set properties in
Expand Down
16 changes: 12 additions & 4 deletions src/main/java/org/apache/commons/jexl3/parser/JexlParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,10 @@ protected void controlPragmaAnywhere() {

/**
* Gets the frame used by this parser.
* <p> Since local variables create new symbols, it is important to
* regain access after parsing to known which / how-many registers are needed. </p>
* <p>
* Since local variables create new symbols, it is important to
* regain access after parsing to known which / how-many registers are needed.
* </p>
* @return the named register map
*/
protected Scope getScope() {
Expand Down Expand Up @@ -438,7 +440,10 @@ protected void declareFunction(final ASTVar variable, final Token token) {

/**
* Declares a local variable.
* <p> This method creates an new entry in the symbol map. </p>
* <p>
* This method creates an new entry in the symbol map.
* </p>
*
* @param variable the identifier used to declare
* @param lexical whether the symbol is lexical
* @param constant whether the symbol is constant
Expand Down Expand Up @@ -476,7 +481,10 @@ protected void declareVariable(final ASTVar variable, final Token token, final b

/**
* Declares a local parameter.
* <p> This method creates an new entry in the symbol map. </p>
* <p>
* This method creates an new entry in the symbol map.
* </p>
*
* @param token the parameter name token
* @param lexical whether the parameter is lexical or not
* @param constant whether the parameter is constant or not
Expand Down

0 comments on commit bf031a5

Please sign in to comment.