You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2016/06/18 12:36:47 UTC
svn commit: r1748987 - in
/commons/proper/bcel/trunk/src/main/java/org/apache/bcel: ./ classfile/
generic/ util/
Author: sebb
Date: Sat Jun 18 12:36:47 2016
New Revision: 1748987
URL: http://svn.apache.org/viewvc?rev=1748987&view=rev
Log:
Javadoc fixes
Modified:
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/Const.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/ExceptionConst.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/BranchInstruction.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Select.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Type.java
commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/InstructionFinder.java
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/Const.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/Const.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/Const.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/Const.java Sat Jun 18 12:36:47 2016
@@ -263,9 +263,8 @@ public final class Const {
public static final int ACCESS_NAMES_LENGTH = ACCESS_NAMES.length;
/**
- *
* @param index
- * @return
+ * @return the ACCESS_NAMES entry at the given index
* @since 6.0
*/
public static String getAccessName(final int index) {
@@ -363,7 +362,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return the CONSTANT_NAMES entry at the given index
* @since 6.0
*/
public static String getConstantName(final int index) {
@@ -387,9 +386,6 @@ public final class Const {
private static final String[] INTERFACES_IMPLEMENTED_BY_ARRAYS = {"java.lang.Cloneable", "java.io.Serializable"};
/**
- *
- * @param index
- * @return
* @since 6.0
*/
public static Iterable<String> getInterfacesImplementedByArrays() {
@@ -1749,7 +1745,7 @@ public final class Const {
* The primitive type names corresponding to the T_XX constants,
* e.g., TYPE_NAMES[T_INT] = "int"
* @param index
- * @return
+ * @return the type name
* @since 6.0
*/
public static String getTypeName(final int index) {
@@ -1771,7 +1767,7 @@ public final class Const {
* The primitive class names corresponding to the T_XX constants,
* e.g., CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer"
* @param index
- * @return
+ * @return the class name
* @since 6.0
*/
public static String getClassTypeName(final int index) {
@@ -1790,7 +1786,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return the short type name
* @since 6.0
*/
public static String getShortTypeName(final int index) {
@@ -1867,7 +1863,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return Number of byte code operands
* @since 6.0
*/
public static short getNoOfOperands(final int index) {
@@ -2081,7 +2077,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return Number of words consumed on operand stack
* @since 6.0
*/
public static int getConsumeStack(final int index) {
@@ -2148,7 +2144,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return Number of words produced onto operand stack
* @since 6.0
*/
public static int getProduceStack(final int index) {
@@ -2197,7 +2193,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return the attribute name
* @since 6.0
*/
public static String getAttributeName(final int index) {
@@ -2224,7 +2220,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return the item name
* @since 6.0
*/
public static String getItemName(final int index) {
@@ -2275,7 +2271,7 @@ public final class Const {
/**
*
* @param index
- * @return
+ * @return the method handle name
* @since 6.0
*/
public static String getMethodHandleName(final int index) {
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/ExceptionConst.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/ExceptionConst.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/ExceptionConst.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/ExceptionConst.java Sat Jun 18 12:36:47 2016
@@ -61,7 +61,7 @@ public final class ExceptionConst {
/**
* Enum corresponding to the various Exception Class arrays,
- * used by {@link ExceptionConstants#createExceptions(EXCS, Class...)}
+ * used by {@link ExceptionConst#createExceptions(EXCS, Class...)}
*/
public enum EXCS {
EXCS_CLASS_AND_INTERFACE_RESOLUTION,
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java Sat Jun 18 12:36:47 2016
@@ -248,32 +248,6 @@ public class DescendingVisitor implement
stack.pop();
}
- /**
- * @since 6.0
- @Override
- public void visitStackMapTable(StackMapTable table)
- {
- stack.push(table);
- table.accept(visitor);
- StackMapTableEntry[] vars = table.getStackMapTable();
- for (StackMapTableEntry var : vars) {
- var.accept(this);
- }
- stack.pop();
- }
- */
-
- /**
- * @since 6.0
- @Override
- public void visitStackMapTableEntry(StackMapTableEntry var)
- {
- stack.push(var);
- var.accept(visitor);
- stack.pop();
- }
- */
-
@Override
public void visitLocalVariable(final LocalVariable var)
{
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/StackMapEntry.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/StackMapEntry.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/classfile/StackMapEntry.java Sat Jun 18 12:36:47 2016
@@ -323,7 +323,7 @@ public final class StackMapEntry impleme
* entry to the next. Note that this might cause the the
* frame type to change. Note also that delta may be negative.
*
- * @param int offset delta
+ * @param delta offset delta
*/
public void updateByteCodeOffset(final int delta) {
setByteCodeOffset(byte_code_offset + delta);
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/BranchInstruction.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/BranchInstruction.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/BranchInstruction.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/BranchInstruction.java Sat Jun 18 12:36:47 2016
@@ -266,7 +266,6 @@ public abstract class BranchInstruction
/**
* @param position the position to set
- * @return the new position
* @since 6.0
*/
protected void setPosition(final int position) {
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FieldOrMethod.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FieldOrMethod.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/FieldOrMethod.java Sat Jun 18 12:36:47 2016
@@ -74,7 +74,7 @@ public abstract class FieldOrMethod exte
* For code generated by Java 1.5, this answer is
* sometimes wrong (e.g., if the "clone()" method is
* called on an array). A better idea is to use
- * the {@link #getReferenceType()} method, which correctly distinguishes
+ * the {@link #getReferenceType(ConstantPoolGen)} method, which correctly distinguishes
* between class types and array types.
*
*/
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Select.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Select.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Select.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Select.java Sat Jun 18 12:36:47 2016
@@ -377,7 +377,7 @@ public abstract class Select extends Bra
/**
*
- * @return
+ * @return the padding
* @since 6.0
*/
final int getPadding() {
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Type.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Type.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Type.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/generic/Type.java Sat Jun 18 12:36:47 2016
@@ -113,8 +113,6 @@ public abstract class Type {
* boolean, short and char variable are considered as int in the stack or local variable area.
* Returns {@link Type#INT} for {@link Type#BOOLEAN}, {@link Type#SHORT} or {@link Type#CHAR}, otherwise
* returns the given type.
- * @see OperandStack#push(Type)
- * @see LocalVariables#set(int, Type)
* @since 6.0
*/
public Type normalizeForStackOrLocal(){
Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/InstructionFinder.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/InstructionFinder.java?rev=1748987&r1=1748986&r2=1748987&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/InstructionFinder.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/util/InstructionFinder.java Sat Jun 18 12:36:47 2016
@@ -61,7 +61,7 @@ import org.apache.bcel.generic.Instructi
* </pre>
*
* @version $Id$
- * @see Instruction
+ * @see org.apache.bcel.generic.Instruction
* @see InstructionList
*/
public class InstructionFinder {