Commit 40a2e694 authored by pcregut's avatar pcregut

Javadoc fixes (indigo is

stricter).
parent 52eecd09
# Release number
release=1.0
# Path to findbugs
findbugs.location=/usr/local/findbugs-1.3.9/lib/findbugs-ant.jar
findbugs.home=/usr/local/findbugs-2.0.0
......@@ -47,7 +47,7 @@ public class DefaultAnnotationVisitor extends AnnotationVisitor {
/**
* Get the information.
* @return
* @return list of info
*/
public List<DefaultAnnotationInformation> getDefaultAnnotationInformationList() {
return infos;
......@@ -57,7 +57,7 @@ public class DefaultAnnotationVisitor extends AnnotationVisitor {
/**
* Get the description
* @return
* @return description
*/
public String getDesc() {
return desc;
......
......@@ -44,7 +44,7 @@ public class EnclosingClassAnnotationVisitor extends AnnotationVisitor {
/**
* Get the class name
* @return
* @return complete name
*/
public String getClassName() {
return className;
......
......@@ -43,7 +43,7 @@ public class EnclosingMethodAnnotationVisitor extends AnnotationVisitor {
int methodId;
/**
* Get the class index in the class pool
* @return
* @return class index
*/
public int getClassId() { return methodId; }
......
......@@ -48,7 +48,7 @@ public class ExceptionAnnotationVisitor extends AnnotationVisitor {
private List<String> classNames = new ArrayList<String>();
/**
* Get the class names of exceptions.
* @return
* @return names of exceptions
*/
public List<String> getClassNames() {
return classNames;
......
......@@ -45,12 +45,12 @@ public class InnerClassAnnotationVisitor extends AnnotationVisitor {
private String simpleName;
/**
* Get the access flags as a bitset
* @return
* @return integer coding the bitset
*/
public int getAccess() { return access; }
/**
* Get the simple name
* @return
* @return name
*/
public String getSimpleName() { return simpleName; }
......
......@@ -46,7 +46,7 @@ public class MemberClassesAnnotationVisitor extends AnnotationVisitor {
private List<String> innerClasses = new ArrayList<String>();
/**
* List of inner classes.
* @return
* @return list of names
*/
public List<String> getInnerClasses() {
return innerClasses;
......
......@@ -46,7 +46,7 @@ public class SignatureAnnotationVisitor extends AnnotationVisitor {
private List<String> signature = new ArrayList<String>();
/**
* signature.
* @return
* @return list of string coding the signature
*/
public List<String> getSignature() {
return signature;
......
......@@ -74,56 +74,56 @@ public class ClassDefinitionItem {
/**
* Index of the class in the class pool
* @return
* @return index
*/
public int getClassIndex() {
return classIndex;
}
/**
* Access flags coded as a bit field
* @return
* @return access flags as in java/dalvik spec
*/
public int getAccessFlags() {
return accessFlags;
}
/**
* Index of super class in the class pool
* @return
* @return index
*/
public int getSuperclassIndex() {
return superclassIndex;
}
/**
* Position of interface definitions as an offset
* @return
* @return absolute offset
*/
public int getInterfacesOffset() {
return interfacesOffset;
}
/**
* Index of source file name in string pool
* @return
* @return index
*/
public int getSourceFileIndex() {
return sourceFileIndex;
}
/**
* Offset of annotation definitions for the class
* @return
* @return offset
*/
public int getAnnotationsOffset() {
return annotationsOffset;
}
/**
* Offset of class content
* @return
* @return offset
*/
public int getClassDataOffset() {
return classDataOffset;
}
/**
* Offset for declarations of static values.
* @return
* @return offset
*/
public int getStaticValuesOffset() {
return staticValuesOffset;
......
......@@ -57,7 +57,7 @@ public class FieldIdItem {
/**
* Class index in the global class pool
* @return
* @return index
*/
public int getClassIndex() {
return classIndex;
......@@ -65,7 +65,7 @@ public class FieldIdItem {
/**
* Type index in the type pool
* @return
* @return index
*/
public int getTypeIndex() {
return typeIndex;
......@@ -73,7 +73,7 @@ public class FieldIdItem {
/**
* Name index in the string pool
* @return
* @return index
*/
public int getNameIndex() {
return nameIndex;
......
......@@ -60,21 +60,21 @@ public class MethodIdItem {
/**
* Accessor of class index in class pool
* @return
* @return index
*/
public int getClassIndex() {
return classIndex;
}
/**
* Accessor of prototype index in prototype pool
* @return
* @return index
*/
public int getPrototypeIndex() {
return prototypeIndex;
}
/**
* Accessor of name index in string pool
* @return
* @return index
*/
public int getNameIndex() {
return nameIndex;
......
......@@ -63,7 +63,7 @@ public class PackedSwitch implements ISwitchCase {
/**
* Minimum value getter
* @return
* @return minimal value filtered
*/
public int getValueMin() {
return valueMin;
......@@ -78,7 +78,7 @@ public class PackedSwitch implements ISwitchCase {
/**
* Max value getter
* @return
* @return max value filtered
*/
public int getValueMax() {
return valueMax;
......
......@@ -59,7 +59,7 @@ public class SparseSwitch implements ISwitchCase {
/**
* Set of values handled.
* @return
* @return the values filtered as an array of integer
*/
public int[] getKeys() {
return keys;
......
......@@ -81,7 +81,7 @@ public class TryCatch {
/**
* Label of first instruction protected
* @return
* @return label of first instruction
*/
public Label getStart() {
return start;
......@@ -89,7 +89,7 @@ public class TryCatch {
/**
* Label of last instruction protected
* @return
* @return label of last instruction
*/
public Label getEnd() {
return end;
......@@ -97,7 +97,7 @@ public class TryCatch {
/**
* Label of exception handler
* @return
* @return label of handler
*/
public Label getHandler() {
return handler;
......@@ -105,7 +105,7 @@ public class TryCatch {
/**
* Type of the exception caught
* @return
* @return type name
*/
public String getType() {
return type;
......
......@@ -280,7 +280,7 @@ public class TestUtil {
* Reads a file and return its content as a byte array.
* @param file the file to load.
* @return the byte array of its content.
* @throws IOException
*
*/
public static byte[] readFile(File file) {
byte[] bytes = null;
......@@ -561,7 +561,6 @@ public class TestUtil {
/**
* Run baksmali with a given set of arguments. org.jf.baksmali.main.main
* @param args
* @return
*/
public static void baksmali(String [] args) throws IOException {
File file = new File(BAKSMALI_JAR);
......
......@@ -46,8 +46,8 @@ import org.ow2.asmdex.structureCommon.*;
public class GenerateBasicDexFile implements Opcodes {
/**
* Constructor
* @return
* generator
* @return code.
*/
public static byte[] generate() {
......
......@@ -47,7 +47,7 @@ public class GenerateDexFileShiftedSwitchCase implements Opcodes {
/**
* Generate the dex file.
* @return
* @return code
*/
public static byte[] generate() {
......
......@@ -46,7 +46,7 @@ public class GenerateDexFileSwitchCase implements Opcodes {
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -48,7 +48,7 @@ public class GenerateExpectedDexFileAddAndRemoveMethod implements Opcodes {
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -47,7 +47,7 @@ public class GenerateExpectedDexFileAddCode implements Opcodes {
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -47,7 +47,7 @@ public class GenerateExpectedDexFileAddMethod implements Opcodes {
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -47,7 +47,7 @@ public class GenerateExpectedDexFileRemoveMethod implements Opcodes {
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -48,7 +48,7 @@ public class GenerateExpectedDexFileResizeGoto8Bits implements Opcodes {
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -49,7 +49,7 @@ public class GenerateExpectedDexFileResizeGoto8BitsDoubleRefs implements Opcodes
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -50,7 +50,7 @@ public class GenerateExpectedDexFileResizeGoto8BitsDoubleRefsDoubleLabels implem
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -47,7 +47,7 @@ public class GenerateOriginalDexFileResizeGoto8Bits implements Opcodes {
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -48,7 +48,7 @@ public class GenerateOriginalDexFileResizeGoto8BitsDoubleRefs implements Opcodes
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -48,7 +48,7 @@ public class GenerateOriginalDexFileResizeGoto8BitsDoubleRefsDoubleLabels implem
/**
* Generate the dex file
* @return
* @return byte code
*/
public static byte[] generate() {
......
......@@ -39,7 +39,10 @@ import java.lang.reflect.Array;
*/
public class LogElementAnnotationVisit extends LogElement {
/** The name. */
protected String name;
/** The value. */
protected Object value;
@Override
......
......@@ -37,7 +37,10 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementAnnotationVisitAnnotation extends LogElement {
/** The name. */
protected String name;
/** The desc. */
protected String desc;
/**
......
......@@ -37,6 +37,7 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementAnnotationVisitArray extends LogElement {
/** The name. */
protected String name;
/**
......
......@@ -37,7 +37,10 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementAnnotationVisitClass extends LogElement {
/** The annotation name. */
protected String annotationName;
/** The class name. */
protected String className;
/**
......
......@@ -37,8 +37,13 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementAnnotationVisitEnum extends LogElement {
/** The name. */
protected String name;
/** The description */
protected String desc;
/** The value. */
protected String value;
/**
......
......@@ -39,10 +39,19 @@ import java.util.Arrays;
*/
public class LogElementApplicationVisitClass extends LogElement {
/** The access flags. */
protected int access;
/** The name. */
protected String name;
/** The signature. */
protected String[] signature;
/** The name of super. */
protected String superName;
/** The interfaces. */
protected String[] interfaces;
@Override
......
......@@ -39,10 +39,19 @@ import java.util.Arrays;
*/
public class LogElementClassVisit extends LogElement {
/** The access flags. */
protected int access;
/** The name. */
protected String name;
/** The signature. */
protected String[] signature;
/** The name of super. */
protected String superName;
/** The interfaces. */
protected String[] interfaces;
@Override
......
......@@ -39,10 +39,19 @@ import java.util.Arrays;
*/
public class LogElementClassVisitField extends LogElement {
/** The access flags. */
protected int access;
/** The name. */
protected String name;
/** The description. */
protected String desc;
/** The signature. */
protected String[] signature;
/** The value. */
protected Object value;
@Override
......
......@@ -32,6 +32,7 @@ package org.objectweb.asmdex.logging;
import java.util.Arrays;
// TODO: Auto-generated Javadoc
/**
* LogElement for the Visit of Method of a Class.
*
......@@ -39,24 +40,35 @@ import java.util.Arrays;
*/
public class LogElementClassVisitMethod extends LogElement {
/** The access. */
protected int access;
/** The name. */
protected String name;
/** The description. */
protected String desc;
/** The signature. */
protected String[] signature;
/** The exceptions. */
protected String[] exceptions;
@Override
public ElementType getType() {
return ElementType.TYPE_CLASS_VISIT_METHOD;
}
/**
* Constructor
* @param access
* @param name
* @param desc
* @param signature
* @param exceptions
* Constructor.
*
* @param access the access
* @param name the name
* @param desc the desc
* @param signature the signature
* @param exceptions the exceptions
*/
public LogElementClassVisitMethod(int access, String name, String desc,
String[] signature, String[] exceptions) {
......@@ -67,6 +79,9 @@ public class LogElementClassVisitMethod extends LogElement {
this.exceptions = exceptions;
}
/* (non-Javadoc)
* @see org.objectweb.asmdex.logging.LogElement#isElementEqual(org.objectweb.asmdex.logging.LogElement)
*/
@Override
public boolean isElementEqual(LogElement e) {
LogElementClassVisitMethod a = (LogElementClassVisitMethod)e;
......
......@@ -37,8 +37,13 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementClassVisitOuterClass extends LogElement {
/** The owner. */
protected String owner;
/** The name. */
protected String name;
/** The description. */
protected String desc;
@Override
......
......@@ -37,6 +37,7 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementClassVisitSource extends LogElement {
/** The source. */
protected String source;
@Override
......
......@@ -37,7 +37,10 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementFieldVisitAnnotation extends LogElement {
/** The description. */
protected String desc;
/** The visibility. */
protected boolean visible;
/**
......
......@@ -37,7 +37,10 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementMethodVisitAnnotation extends LogElement {
/** The visibility. */
protected boolean visible;
/** The description. */
protected String desc;
/**
......
......@@ -37,7 +37,10 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementMethodVisitArrayLengthInsn extends LogElement {
/** The destination register. */
protected int destinationRegister;
/** The array reference bearing. */
protected int arrayReferenceBearing;
/**
......
......@@ -37,9 +37,16 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementMethodVisitArrayOperationInsn extends LogElement {
/** The opcode. */
protected int opcode;
/** The value register. */
protected int valueRegister;
/** The array register. */
protected int arrayRegister;
/** The index register. */
protected int indexRegister;
/**
......
......@@ -37,11 +37,22 @@ package org.objectweb.asmdex.logging;
*/
public class LogElementMethodVisitFieldInsn extends LogElement {
/** The opcode. */
protected int opcode;
/** The owner. */
protected String owner;