Commit 303ff45a authored by Eric Bruneton's avatar Eric Bruneton

Merge branch 'unfork/doc' into 'master'

Minor Javadoc improvements

See merge request !182
parents c72a86bd 43655e34
...@@ -85,7 +85,7 @@ public abstract class Interpreter<V extends Value> { ...@@ -85,7 +85,7 @@ public abstract class Interpreter<V extends Value> {
* *
* @param insn the bytecode instruction to be interpreted. * @param insn the bytecode instruction to be interpreted.
* @return the result of the interpretation of the given instruction. * @return the result of the interpretation of the given instruction.
* @throws AnalyzerException if an error occured during the interpretation. * @throws AnalyzerException if an error occurred during the interpretation.
*/ */
public abstract V newOperation(AbstractInsnNode insn) throws AnalyzerException; public abstract V newOperation(AbstractInsnNode insn) throws AnalyzerException;
...@@ -100,7 +100,7 @@ public abstract class Interpreter<V extends Value> { ...@@ -100,7 +100,7 @@ public abstract class Interpreter<V extends Value> {
* @param value the value that must be moved by the instruction. * @param value the value that must be moved by the instruction.
* @return the result of the interpretation of the given instruction. The returned value must be * @return the result of the interpretation of the given instruction. The returned value must be
* <tt>equal</tt> to the given value. * <tt>equal</tt> to the given value.
* @throws AnalyzerException if an error occured during the interpretation. * @throws AnalyzerException if an error occurred during the interpretation.
*/ */
public abstract V copyOperation(AbstractInsnNode insn, V value) throws AnalyzerException; public abstract V copyOperation(AbstractInsnNode insn, V value) throws AnalyzerException;
...@@ -116,7 +116,7 @@ public abstract class Interpreter<V extends Value> { ...@@ -116,7 +116,7 @@ public abstract class Interpreter<V extends Value> {
* @param insn the bytecode instruction to be interpreted. * @param insn the bytecode instruction to be interpreted.
* @param value the argument of the instruction to be interpreted. * @param value the argument of the instruction to be interpreted.
* @return the result of the interpretation of the given instruction. * @return the result of the interpretation of the given instruction.
* @throws AnalyzerException if an error occured during the interpretation. * @throws AnalyzerException if an error occurred during the interpretation.
*/ */
public abstract V unaryOperation(AbstractInsnNode insn, V value) throws AnalyzerException; public abstract V unaryOperation(AbstractInsnNode insn, V value) throws AnalyzerException;
...@@ -134,7 +134,7 @@ public abstract class Interpreter<V extends Value> { ...@@ -134,7 +134,7 @@ public abstract class Interpreter<V extends Value> {
* @param value1 the first argument of the instruction to be interpreted. * @param value1 the first argument of the instruction to be interpreted.
* @param value2 the second argument of the instruction to be interpreted. * @param value2 the second argument of the instruction to be interpreted.
* @return the result of the interpretation of the given instruction. * @return the result of the interpretation of the given instruction.
* @throws AnalyzerException if an error occured during the interpretation. * @throws AnalyzerException if an error occurred during the interpretation.
*/ */
public abstract V binaryOperation(AbstractInsnNode insn, V value1, V value2) public abstract V binaryOperation(AbstractInsnNode insn, V value1, V value2)
throws AnalyzerException; throws AnalyzerException;
...@@ -150,7 +150,7 @@ public abstract class Interpreter<V extends Value> { ...@@ -150,7 +150,7 @@ public abstract class Interpreter<V extends Value> {
* @param value2 the second argument of the instruction to be interpreted. * @param value2 the second argument of the instruction to be interpreted.
* @param value3 the third argument of the instruction to be interpreted. * @param value3 the third argument of the instruction to be interpreted.
* @return the result of the interpretation of the given instruction. * @return the result of the interpretation of the given instruction.
* @throws AnalyzerException if an error occured during the interpretation. * @throws AnalyzerException if an error occurred during the interpretation.
*/ */
public abstract V ternaryOperation(AbstractInsnNode insn, V value1, V value2, V value3) public abstract V ternaryOperation(AbstractInsnNode insn, V value1, V value2, V value3)
throws AnalyzerException; throws AnalyzerException;
...@@ -165,7 +165,7 @@ public abstract class Interpreter<V extends Value> { ...@@ -165,7 +165,7 @@ public abstract class Interpreter<V extends Value> {
* @param insn the bytecode instruction to be interpreted. * @param insn the bytecode instruction to be interpreted.
* @param values the arguments of the instruction to be interpreted. * @param values the arguments of the instruction to be interpreted.
* @return the result of the interpretation of the given instruction. * @return the result of the interpretation of the given instruction.
* @throws AnalyzerException if an error occured during the interpretation. * @throws AnalyzerException if an error occurred during the interpretation.
*/ */
public abstract V naryOperation(AbstractInsnNode insn, List<? extends V> values) public abstract V naryOperation(AbstractInsnNode insn, List<? extends V> values)
throws AnalyzerException; throws AnalyzerException;
...@@ -178,7 +178,7 @@ public abstract class Interpreter<V extends Value> { ...@@ -178,7 +178,7 @@ public abstract class Interpreter<V extends Value> {
* @param insn the bytecode instruction to be interpreted. * @param insn the bytecode instruction to be interpreted.
* @param value the argument of the instruction to be interpreted. * @param value the argument of the instruction to be interpreted.
* @param expected the expected return type of the analyzed method. * @param expected the expected return type of the analyzed method.
* @throws AnalyzerException if an error occured during the interpretation. * @throws AnalyzerException if an error occurred during the interpretation.
*/ */
public abstract void returnOperation(AbstractInsnNode insn, V value, V expected) public abstract void returnOperation(AbstractInsnNode insn, V value, V expected)
throws AnalyzerException; throws AnalyzerException;
......
...@@ -43,6 +43,8 @@ public class MethodInsnNode extends AbstractInsnNode { ...@@ -43,6 +43,8 @@ public class MethodInsnNode extends AbstractInsnNode {
/** /**
* The internal name of the method's owner class (see {@link * The internal name of the method's owner class (see {@link
* org.objectweb.asm.Type#getInternalName()}). * org.objectweb.asm.Type#getInternalName()}).
*
* For methods of arrays, e.g., <tt>clone()</tt>, the array type descriptor.
*/ */
public String owner; public String owner;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment