Skip to content

Commit 86553fa

Browse files
committed
JAVADOC fixes.
1 parent cbdefd0 commit 86553fa

File tree

8 files changed

+27
-19
lines changed

8 files changed

+27
-19
lines changed

commons-compiler-jdk/src/org/codehaus/commons/compiler/jdk/ExpressionEvaluator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
* On my system (Intel P4, 2 GHz, MS Windows XP, JDK 1.4.1), expression "x + 1"
6969
* evaluates as follows:
7070
* <table>
71-
* <tr><td></td><th>Server JVM</th><th>Client JVM</th></td></tr>
71+
* <tr><td></td><th>Server JVM</th><th>Client JVM</th></tr>
7272
* <tr><td>Normal EE</td><td>23.7 ns</td><td>64.0 ns</td></tr>
7373
* <tr><td>Fast EE</td><td>31.2 ns</td><td>42.2 ns</td></tr>
7474
* </table>

janino/src/org/codehaus/janino/ByteArrayClassLoader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class ByteArrayClassLoader extends ClassLoader {
3535
/**
3636
* The given {@link Map} of classes must not be modified afterwards.
3737
*
38-
* @param classes String className => byte[] data
38+
* @param classes String className =&gt; byte[] data
3939
*/
4040
public
4141
ByteArrayClassLoader(Map<String /*className*/, byte[] /*data*/> classes) { this.classes = classes; }

janino/src/org/codehaus/janino/CachingJavaSourceClassLoader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ class CachingJavaSourceClassLoader extends JavaSourceClassLoader {
126126
/**
127127
* Override {@link JavaSourceClassLoader#generateBytecodes(String)} to implement class file caching.
128128
*
129-
* @return String name => byte[] bytecode, or {@code null} if no source code could be found
129+
* @return String name =&gt; byte[] bytecode, or {@code null} if no source code could be found
130130
* @throws ClassNotFoundException Compilation problems or class file cache I/O problems
131131
*/
132132
@Override protected Map<String /*name*/, byte[] /*bytecode*/>

janino/src/org/codehaus/janino/ExpressionEvaluator.java

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
* On my system (Intel P4, 2 GHz, MS Windows XP, JDK 1.4.1), expression "x + 1"
8383
* evaluates as follows:
8484
* <table>
85-
* <tr><td></td><th>Server JVM</th><th>Client JVM</th></td></tr>
85+
* <tr><td></td><th>Server JVM</th><th>Client JVM</th></tr>
8686
* <tr><td>Normal EE</td><td>23.7 ns</td><td>64.0 ns</td></tr>
8787
* <tr><td>Fast EE</td><td>31.2 ns</td><td>42.2 ns</td></tr>
8888
* </table>
@@ -191,7 +191,11 @@ class ExpressionEvaluator extends ScriptEvaluator implements IExpressionEvaluato
191191
}
192192

193193
/**
194-
* Equivalent to<pre>
194+
* Creates an expression evaluator with the full configurability.
195+
* <p>
196+
* Equivalent to:
197+
* </p>
198+
* <pre>
195199
* ExpressionEvaluator ee = new ExpressionEvaluator();
196200
* ee.setClassName(className);
197201
* ee.setExtendedType(optionalExtendedType);
@@ -203,6 +207,7 @@ class ExpressionEvaluator extends ScriptEvaluator implements IExpressionEvaluato
203207
* ee.setThrownExceptions(thrownExceptions);
204208
* ee.setParentClassLoader(optionalParentClassLoader);
205209
* ee.cook(scanner);
210+
* </pre>
206211
*
207212
* @see IExpressionEvaluator
208213
* @see IClassBodyEvaluator#setClassName(String)

janino/src/org/codehaus/janino/Java.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1468,7 +1468,7 @@ class FunctionDeclarator extends AbstractTypeBodyDeclaration implements DocComme
14681468
/** The return type of the function (VOID for constructors). */
14691469
public final Type type;
14701470

1471-
/** The name of the function ("<init>" for constructors. */
1471+
/** The name of the function ({@code "<init>"} for constructors). */
14721472
public final String name;
14731473

14741474
/** The parameters of the function. */
@@ -3697,7 +3697,7 @@ class Instanceof extends Rvalue {
36973697
* <dd>JLS7 15.21 'equality operation'
36983698
* <dt>!=
36993699
* <dd>JLS7 15.22 'non-equality operation'
3700-
* <dt>&lt; > &lt;= >=
3700+
* <dt>&lt; &gt; &lt;= &gt;=
37013701
* <dd>JLS7 15.20.1 'numerical comparison operations'
37023702
* </dl>
37033703
* Operations with non-boolean result:
@@ -3712,7 +3712,7 @@ class Instanceof extends Rvalue {
37123712
* <dd>JLS7 15.17 'multiplicative operations'
37133713
* <dt>+ -
37143714
* <dd>JLS7 15.18 'additive operations'
3715-
* <dt>&lt;&lt; >> >>>
3715+
* <dt>&lt;&lt; &gt;&gt; &gt;&gt;&gt;
37163716
* <dd>JLS7 15.19 'shift operations'
37173717
* </dl>
37183718
*/

janino/src/org/codehaus/janino/JavaSourceClassLoader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ class JavaSourceClassLoader extends AbstractJavaSourceClassLoader {
206206
* bytecode. This may cause more compilation units being scanned and parsed. Continue until
207207
* all compilation units are compiled.
208208
*
209-
* @return String name => byte[] bytecode, or <code>null</code> if no source code could be found
209+
* @return String name =&gt; byte[] bytecode, or <code>null</code> if no source code could be found
210210
* @throws ClassNotFoundException on compilation problems
211211
*/
212212
protected Map<String /*name*/, byte[] /*bytecode*/>

janino/src/org/codehaus/janino/Parser.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1892,8 +1892,8 @@ class InterfaceDeclarationContext extends Enumerator {
18921892
* ConditionalExpression [ AssignmentOperator AssignmentExpression ]
18931893
*
18941894
* AssignmentOperator :=
1895-
* '=' | '*=' | '/=' | '%=' | '+=' | '-=' | '<<=' |
1896-
* '>>=' | '>>>=' | '&=' | '^=' | '|='
1895+
* '=' | '*=' | '/=' | '%=' | '+=' | '-=' | '&lt;&lt;=' |
1896+
* '&gt;&gt;=' | '&gt;&gt;&gt;=' | '&amp;=' | '^=' | '|='
18971897
* </pre>
18981898
*/
18991899
public Atom
@@ -1954,7 +1954,7 @@ class InterfaceDeclarationContext extends Enumerator {
19541954
/**
19551955
* <pre>
19561956
* ConditionalAndExpression :=
1957-
* InclusiveOrExpression { '&&' InclusiveOrExpression }
1957+
* InclusiveOrExpression { '&amp;&amp;' InclusiveOrExpression }
19581958
* </pre>
19591959
*/
19601960
public Atom
@@ -2017,7 +2017,7 @@ class InterfaceDeclarationContext extends Enumerator {
20172017
/**
20182018
* <pre>
20192019
* AndExpression :=
2020-
* EqualityExpression { '&' EqualityExpression }
2020+
* EqualityExpression { '&amp;' EqualityExpression }
20212021
* </pre>
20222022
*/
20232023
public Atom
@@ -2061,9 +2061,9 @@ class InterfaceDeclarationContext extends Enumerator {
20612061
* RelationalExpression :=
20622062
* ShiftExpression {
20632063
* 'instanceof' ReferenceType
2064-
* | '<' ShiftExpression [ { ',' TypeArgument } '>' ]
2065-
* | '<' TypeArgument [ { ',' TypeArgument } '>' ]
2066-
* | ( '>' | '<=' | '>=' ) ShiftExpression
2064+
* | '&lt;' ShiftExpression [ { ',' TypeArgument } '&gt;' ]
2065+
* | '&lt;' TypeArgument [ { ',' TypeArgument } '&gt;' ]
2066+
* | ( '&gt;' | '&lt;=' | '&gt;=' ) ShiftExpression
20672067
* }
20682068
* </pre>
20692069
*/
@@ -2161,7 +2161,7 @@ class InterfaceDeclarationContext extends Enumerator {
21612161
/**
21622162
* <pre>
21632163
* ShiftExpression :=
2164-
* AdditiveExpression { ( '<<' | '>>' | '>>>' ) AdditiveExpression }
2164+
* AdditiveExpression { ( '&lt;&lt;' | '&gt;&gt;' | '&gt;&gt;&gt;' ) AdditiveExpression }
21652165
* </pre>
21662166
*/
21672167
public Atom

janino/src/org/codehaus/janino/Scanner.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ class Scanner {
238238
* of future calls to {@link #produce()} are undefined.
239239
*
240240
* @deprecated This method is deprecated, because the concept described above is confusing. An application should
241-
* close the underlying {@link InputStream} or {@link Reader} itself.</b>
241+
* close the underlying {@link InputStream} or {@link Reader} itself
242242
*/
243243
@Deprecated public void
244244
close() throws IOException { this.in.close(); }
@@ -311,7 +311,10 @@ class Token {
311311
/** The token represents the {@code null} literal; its {@link #value} is 'null'. */
312312
public static final int NULL_LITERAL = 8;
313313

314-
/** The token represents an operator; its {@link #value} is exactly the particular operator (e.g. "<<<="). */
314+
/**
315+
* The token represents an operator; its {@link #value} is exactly the particular operator (e.g.
316+
* "&lt;&lt;&lt;=").
317+
*/
315318
public static final int OPERATOR = 9;
316319

317320
/** The text of the token exactly as it appears in the source code. */

0 commit comments

Comments
 (0)