You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by eb...@apache.org on 2014/08/25 01:40:28 UTC
svn commit: r1620239 - in
/commons/proper/bcel/trunk/src/main/java/org/apache/bcel: classfile/
generic/ util/ verifier/statics/ verifier/structurals/
Author: ebourg
Date: Sun Aug 24 23:40:27 2014
New Revision: 1620239
URL: http://svn.apache.org/r1620239
Log:
Fixed Javadoc errors reported by Java 8
Modified:
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/Utility.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPG.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPL.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPG.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPL.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionList.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LCMP.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LLOAD.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/TargetLostException.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/JavaWrapper.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/structurals/ExecutionVisitor.java
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/Utility.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/Utility.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/Utility.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/Utility.java Sun Aug 24 23:40:27 2014
@@ -648,18 +648,24 @@ public abstract class Utility {
* A returntype signature represents the return value from a method.
* It is a series of bytes in the following grammar:
*
- * <return_signature> ::= <field_type> | V
+ * <pre>
+ * <return_signature> ::= <field_type> | V
+ * </pre>
*
* The character V indicates that the method returns no value. Otherwise, the
* signature indicates the type of the return value.
* An argument signature represents an argument passed to a method:
*
- * <argument_signature> ::= <field_type>
+ * <pre>
+ * <argument_signature> ::= <field_type>
+ * </pre>
*
* A method signature represents the arguments that the method expects, and
* the value that it returns.
- * <method_signature> ::= (<arguments_signature>) <return_signature>
- * <arguments_signature>::= <argument_signature>*
+ * <pre>
+ * <method_signature> ::= (<arguments_signature>) <return_signature>
+ * <arguments_signature>::= <argument_signature>*
+ * </pre>
*
* This method converts such a string into a Java type declaration like
* `void main(String[])' and throws a `ClassFormatException' when the parsed
@@ -772,11 +778,11 @@ public abstract class Utility {
* following grammar:
*
* <PRE>
- * <field_signature> ::= <field_type>
- * <field_type> ::= <base_type>|<object_type>|<array_type>
- * <base_type> ::= B|C|D|F|I|J|S|Z
- * <object_type> ::= L<fullclassname>;
- * <array_type> ::= [<field_type>
+ * <field_signature> ::= <field_type>
+ * <field_type> ::= <base_type>|<object_type>|<array_type>
+ * <base_type> ::= B|C|D|F|I|J|S|Z
+ * <object_type> ::= L<fullclassname>;
+ * <array_type> ::= [<field_type>
*
* The meaning of the base types is as follows:
* B byte signed byte
@@ -785,10 +791,10 @@ public abstract class Utility {
* F float single precision IEEE float
* I int integer
* J long long integer
- * L<fullclassname>; ... an object of the given class
+ * L<fullclassname>; ... an object of the given class
* S short signed short
* Z boolean true or false
- * [<field sig> ... array
+ * [<field sig> ... array
* </PRE>
*
* This method converts this string into a Java type declaration such as
@@ -1168,16 +1174,18 @@ public abstract class Utility {
}
- /** Encode byte array it into Java identifier string, i.e., a string
+ /**
+ * Encode byte array it into Java identifier string, i.e., a string
* that only contains the following characters: (a, ... z, A, ... Z,
* 0, ... 9, _, $). The encoding algorithm itself is not too
* clever: if the current byte's ASCII value already is a valid Java
* identifier part, leave it as it is. Otherwise it writes the
- * escape character($) followed by <p><ul><li> the ASCII value as a
- * hexadecimal string, if the value is not in the range
- * 200..247</li> <li>a Java identifier char not used in a lowercase
- * hexadecimal string, if the value is in the range
- * 200..247</li><ul></p>
+ * escape character($) followed by:
+ *
+ * <ul>
+ * <li> the ASCII value as a hexadecimal string, if the value is not in the range 200..247</li>
+ * <li>a Java identifier char not used in a lowercase hexadecimal string, if the value is in the range 200..247</li>
+ * </ul>
*
* <p>This operation inflates the original byte array by roughly 40-50%</p>
*
@@ -1206,7 +1214,8 @@ public abstract class Utility {
}
- /** Decode a string back to a byte array.
+ /**
+ * Decode a string back to a byte array.
*
* @param s the string to convert
* @param uncompress use gzip to uncompress the stream of bytes
@@ -1264,7 +1273,8 @@ public abstract class Utility {
MAP_CHAR['_'] = j;
}
- /** Decode characters into bytes.
+ /**
+ * Decode characters into bytes.
* Used by <a href="Utility.html#decode(java.lang.String, boolean)">decode()</a>
*/
private static class JavaReader extends FilterReader {
@@ -1308,7 +1318,8 @@ public abstract class Utility {
}
}
- /** Encode bytes into valid java identifier characters.
+ /**
+ * Encode bytes into valid java identifier characters.
* Used by <a href="Utility.html#encode(byte[], boolean)">encode()</a>
*/
private static class JavaWriter extends FilterWriter {
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPG.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPG.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPG.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPG.java Sun Aug 24 23:40:27 2014
@@ -18,9 +18,8 @@
package org.apache.bcel.generic;
/**
- * DCMPG - Compare doubles: value1 > value2
- * <PRE>Stack: ..., value1.word1, value1.word2, value2.word1, value2.word2 -></PRE>
- * ..., result
+ * DCMPG - Compare doubles: value1 > value2
+ * <PRE>Stack: ..., value1.word1, value1.word2, value2.word1, value2.word2 -> ..., result</PRE>
*
* @version $Id$
* @author <A HREF="mailto:m.dahm@gmx.de">M. Dahm</A>
@@ -29,19 +28,16 @@ public class DCMPG extends Instruction i
private static final long serialVersionUID = 1929664840821745262L;
-
public DCMPG() {
super(org.apache.bcel.Constants.DCMPG, (short) 1);
}
-
/** @return Type.DOUBLE
*/
public Type getType( ConstantPoolGen cp ) {
return Type.DOUBLE;
}
-
/**
* Call corresponding visitor method(s). The order is:
* Call visitor methods of implemented interfaces first, then
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPL.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPL.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPL.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/DCMPL.java Sun Aug 24 23:40:27 2014
@@ -18,9 +18,8 @@
package org.apache.bcel.generic;
/**
- * DCMPL - Compare doubles: value1 < value2
- * <PRE>Stack: ..., value1.word1, value1.word2, value2.word1, value2.word2 -></PRE>
- * ..., result
+ * DCMPL - Compare doubles: value1 < value2
+ * <PRE>Stack: ..., value1.word1, value1.word2, value2.word1, value2.word2 -> ..., result</PRE>
*
* @version $Id$
* @author <A HREF="mailto:m.dahm@gmx.de">M. Dahm</A>
@@ -29,19 +28,16 @@ public class DCMPL extends Instruction i
private static final long serialVersionUID = 2514357528484232014L;
-
public DCMPL() {
super(org.apache.bcel.Constants.DCMPL, (short) 1);
}
-
/** @return Type.DOUBLE
*/
public Type getType( ConstantPoolGen cp ) {
return Type.DOUBLE;
}
-
/**
* Call corresponding visitor method(s). The order is:
* Call visitor methods of implemented interfaces first, then
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPG.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPG.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPG.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPG.java Sun Aug 24 23:40:27 2014
@@ -18,7 +18,7 @@
package org.apache.bcel.generic;
/**
- * FCMPG - Compare floats: value1 > value2
+ * FCMPG - Compare floats: value1 > value2
* <PRE>Stack: ..., value1, value2 -> ..., result</PRE>
*
* @version $Id$
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPL.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPL.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPL.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FCMPL.java Sun Aug 24 23:40:27 2014
@@ -18,7 +18,7 @@
package org.apache.bcel.generic;
/**
- * FCMPL - Compare floats: value1 < value2
+ * FCMPL - Compare floats: value1 < value2
* <PRE>Stack: ..., value1, value2 -> ..., result</PRE>
*
* @version $Id$
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionList.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionList.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionList.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/InstructionList.java Sun Aug 24 23:40:27 2014
@@ -1123,8 +1123,7 @@ public class InstructionList implements
/**
* Delete contents of list. Provides besser memory utilization,
* because the system then may reuse the instruction handles. This
- * method is typically called right after
- * <href="MethodGen.html#getMethod()">MethodGen.getMethod()</a>.
+ * method is typically called right after {@link MethodGen#getMethod()}.
*/
public void dispose() {
// Traverse in reverse order, because ih.next is overwritten
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LCMP.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LCMP.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LCMP.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LCMP.java Sun Aug 24 23:40:27 2014
@@ -19,8 +19,8 @@ package org.apache.bcel.generic;
/**
* LCMP - Compare longs:
- * <PRE>Stack: ..., value1.word1, value1.word2, value2.word1, value2.word2 -></PRE>
- * ..., result <= -1, 0, 1>
+ * <PRE>Stack: ..., value1.word1, value1.word2, value2.word1, value2.word2 -> ..., result <= -1, 0, 1></PRE>
+ *
*
* @version $Id$
* @author <A HREF="mailto:m.dahm@gmx.de">M. Dahm</A>
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LLOAD.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LLOAD.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LLOAD.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/LLOAD.java Sun Aug 24 23:40:27 2014
@@ -19,7 +19,7 @@ package org.apache.bcel.generic;
/**
* LLOAD - Load long from local variable
- *<PRE>Stack ... -> ..., result.word1, result.word2</PRE>
+ *<PRE>Stack ... -> ..., result.word1, result.word2</PRE>
*
* @version $Id$
* @author <A HREF="mailto:m.dahm@gmx.de">M. Dahm</A>
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/TargetLostException.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/TargetLostException.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/TargetLostException.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/TargetLostException.java Sun Aug 24 23:40:27 2014
@@ -23,9 +23,9 @@ package org.apache.bcel.generic;
* InstructionTargeter has to be notified that (one of) the InstructionHandle it
* is referencing is being removed from the InstructionList and thus not valid anymore.
*
- * Making this an exception instead of a return value forces the user to handle
+ * <p>Making this an exception instead of a return value forces the user to handle
* these case explicitely in a try { ... } catch. The following code illustrates
- * how this may be done:
+ * how this may be done:</p>
*
* <PRE>
* ...
@@ -33,10 +33,10 @@ package org.apache.bcel.generic;
* il.delete(start_ih, end_ih);
* } catch(TargetLostException e) {
* InstructionHandle[] targets = e.getTargets();
- * for(int i=0; i < targets.length; i++) {
+ * for(int i=0; i < targets.length; i++) {
* InstructionTargeter[] targeters = targets[i].getTargeters();
*
- * for(int j=0; j < targeters.length; j++)
+ * for(int j=0; j < targeters.length; j++)
* targeters[j].updateTarget(targets[i], new_target);
* }
* }
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/JavaWrapper.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/JavaWrapper.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/JavaWrapper.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/JavaWrapper.java Sun Aug 24 23:40:27 2014
@@ -24,13 +24,13 @@ import java.lang.reflect.Modifier;
* Java interpreter replacement, i.e., wrapper that uses its own ClassLoader
* to modify/generate classes as they're requested. You can take this as a template
* for your own applications.<br>
- * Call this wrapper with
+ * Call this wrapper with:
+ *
* <pre>java org.apache.bcel.util.JavaWrapper <real.class.name> [arguments]</pre>
- * <p>
- * To use your own class loader you can set the "bcel.classloader" system property
- * which defaults to "org.apache.bcel.util.ClassLoader", e.g., with
+ *
+ * <p>To use your own class loader you can set the "bcel.classloader" system property
+ * which defaults to "org.apache.bcel.util.ClassLoader", e.g., with:</p>
* <pre>java org.apache.bcel.util.JavaWrapper -Dbcel.classloader=foo.MyLoader <real.class.name> [arguments]</pre>
- * </p>
*
* @version $Id$
* @author <A HREF="mailto:m.dahm@gmx.de">M. Dahm</A>
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java Sun Aug 24 23:40:27 2014
@@ -112,7 +112,7 @@ public final class Pass1Verifier extends
* <LI> All undocumented access flags are masked off before use. Strictly speaking, this is not really a check.
* <LI> The field this_class should point to a string that represents a legal non-array class name, and this name should be the same as the class file being loaded.
* <LI> the field super_class should point to a string that represents a legal non-array class name.
- * <LI> Because some of the above checks require cross referencing the constant pool entries, guards are set up to make sure that the referenced entries are of the right type and the indices are within the legal range (0 < index < constant_pool_count).
+ * <LI> Because some of the above checks require cross referencing the constant pool entries, guards are set up to make sure that the referenced entries are of the right type and the indices are within the legal range (0 < index < constant_pool_count).
* </UL>
* <LI> Extra checks done in pass 1:
* <UL>
@@ -122,12 +122,12 @@ public final class Pass1Verifier extends
* </UL>
* </UL>
* (From the Paper <A HREF=http://www.cs.sfu.ca/people/GradStudents/pwfong/personal/JVM/pass1/>The Mysterious Pass One, first draft, September 2, 1997</A>.)
- * </BR>
- * However, most of this is done by parsing a class file or generating a class file into BCEL's internal data structure.
+ *
+ * <P>However, most of this is done by parsing a class file or generating a class file into BCEL's internal data structure.
* <B>Therefore, all that is really done here is look up the class file from BCEL's repository.</B>
* This is also motivated by the fact that some omitted things
* (like the check for extra bytes at the end of the class file) are handy when actually using BCEL to repair a class file (otherwise you would not be
- * able to load it into BCEL).
+ * able to load it into BCEL).</P>
*
* @see org.apache.bcel.Repository
*/
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/structurals/ExecutionVisitor.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/structurals/ExecutionVisitor.java?rev=1620239&r1=1620238&r2=1620239&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/structurals/ExecutionVisitor.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/structurals/ExecutionVisitor.java Sun Aug 24 23:40:27 2014
@@ -31,7 +31,8 @@ import org.apache.bcel.generic.*;
/**
* This Visitor class may be used for a type-based Java Virtual Machine
* simulation.
- * It does not check for correct types on the OperandStack or in the
+ *
+ * <p>It does not check for correct types on the OperandStack or in the
* LocalVariables; nor does it check their sizes are sufficiently big.
* Thus, to use this Visitor for bytecode verifying, you have to make sure
* externally that the type constraints of the Java Virtual Machine instructions
@@ -40,16 +41,17 @@ import org.apache.bcel.generic.*;
* visitIADD(IADD o), then there are two stack slots popped and one
* stack slot containing a Type.INT is pushed (where you could also
* pop only one slot if you know there are two Type.INT on top of the
- * stack). Monitor-specific behaviour is not simulated.
+ * stack). Monitor-specific behaviour is not simulated.</p>
*
- * </P><B>Conventions:</B>
+ * <b>Conventions:</b>
*
- * Type.VOID will never be pushed onto the stack. Type.DOUBLE and Type.LONG
+ * <p>Type.VOID will never be pushed onto the stack. Type.DOUBLE and Type.LONG
* that would normally take up two stack slots (like Double_HIGH and
* Double_LOW) are represented by a simple single Type.DOUBLE or Type.LONG
- * object on the stack here.
- * If a two-slot type is stored into a local variable, the next variable
- * is given the type Type.UNKNOWN.
+ * object on the stack here.</p>
+ *
+ * <p>If a two-slot type is stored into a local variable, the next variable
+ * is given the type Type.UNKNOWN.</p>
*
* @version $Id$
* @author Enver Haase