You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/12/17 15:28:29 UTC
(commons-bcel) branch master updated: Better Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bcel.git
The following commit(s) were added to refs/heads/master by this push:
new 7e5e7d75 Better Javadoc
new b3289a8f Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-bcel.git
7e5e7d75 is described below
commit 7e5e7d75ded63610469dc59f7a5c37792423005c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Dec 17 10:27:58 2023 -0500
Better Javadoc
---
src/main/java/org/apache/bcel/classfile/JavaClass.java | 6 +++---
src/main/java/org/apache/bcel/generic/ArrayType.java | 2 +-
src/main/java/org/apache/bcel/generic/ExceptionThrower.java | 2 +-
src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java | 4 ++--
src/main/java/org/apache/bcel/generic/ObjectType.java | 4 ++--
src/main/java/org/apache/bcel/generic/ReferenceType.java | 8 ++++----
src/main/java/org/apache/bcel/generic/Type.java | 4 ++--
src/main/java/org/apache/bcel/verifier/VerifyDialog.java | 4 ++--
src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java | 2 +-
.../org/apache/bcel/verifier/structurals/ExceptionHandler.java | 2 +-
.../java/org/apache/bcel/verifier/structurals/GenericArray.java | 2 +-
11 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/src/main/java/org/apache/bcel/classfile/JavaClass.java b/src/main/java/org/apache/bcel/classfile/JavaClass.java
index 210441f9..067a9f53 100644
--- a/src/main/java/org/apache/bcel/classfile/JavaClass.java
+++ b/src/main/java/org/apache/bcel/classfile/JavaClass.java
@@ -634,7 +634,7 @@ public class JavaClass extends AccessFlags implements Cloneable, Node, Comparabl
}
/**
- * @return the superclass for this JavaClass object, or null if this is java.lang.Object
+ * @return the superclass for this JavaClass object, or null if this is {@link Object}
* @throws ClassNotFoundException if the superclass can't be found
*/
public JavaClass getSuperClass() throws ClassNotFoundException {
@@ -658,8 +658,8 @@ public class JavaClass extends AccessFlags implements Cloneable, Node, Comparabl
}
/**
- * returns the super class name of this class. In the case that this class is java.lang.Object, it will return itself
- * (java.lang.Object). This is probably incorrect but isn't fixed at this time to not break existing clients.
+ * returns the super class name of this class. In the case that this class is {@link Object}, it will return itself
+ * ({@link Object}). This is probably incorrect but isn't fixed at this time to not break existing clients.
*
* @return Superclass name.
*/
diff --git a/src/main/java/org/apache/bcel/generic/ArrayType.java b/src/main/java/org/apache/bcel/generic/ArrayType.java
index 6b846a3c..d0c7501b 100644
--- a/src/main/java/org/apache/bcel/generic/ArrayType.java
+++ b/src/main/java/org/apache/bcel/generic/ArrayType.java
@@ -39,7 +39,7 @@ public final class ArrayType extends ReferenceType {
/**
* Convenience constructor for reference array type, e.g. Object[]
*
- * @param className complete name of class (java.lang.String, e.g.)
+ * @param className complete name of class ({@link String}, for example)
* @param dimensions array dimensions
*/
public ArrayType(final String className, final int dimensions) {
diff --git a/src/main/java/org/apache/bcel/generic/ExceptionThrower.java b/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
index 8fa73e76..b21c6201 100644
--- a/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
+++ b/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
@@ -18,7 +18,7 @@ package org.apache.bcel.generic;
/**
* Denote an instruction that may throw a run-time or a linking exception (or both) during execution. This is not quite
- * the truth as such; because all instructions may throw an java.lang.VirtualMachineError. These exceptions are omitted.
+ * the truth as such; because all instructions may throw a {@link VirtualMachineError}. These exceptions are omitted.
*
* The Lava Language Specification specifies exactly which <i>RUN-TIME</i> and which <i>LINKING</i> exceptions each
* instruction may throw which is reflected by the implementers. Due to the structure of the JVM specification, it may
diff --git a/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java b/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java
index dd935b79..d849de4b 100644
--- a/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java
+++ b/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java
@@ -98,11 +98,11 @@ public class INVOKEDYNAMIC extends InvokeInstruction {
}
/**
- * Since InvokeDynamic doesn't refer to a reference type, just return java.lang.Object, as that is the only type we can
+ * Since InvokeDynamic doesn't refer to a reference type, just return {@link Object}, as that is the only type we can
* say for sure the reference will be.
*
* @param cpg the ConstantPoolGen used to create the instruction
- * @return an ObjectType for java.lang.Object
+ * @return an ObjectType for {@link Object}
* @since 6.1
*/
@Override
diff --git a/src/main/java/org/apache/bcel/generic/ObjectType.java b/src/main/java/org/apache/bcel/generic/ObjectType.java
index 28e21254..95a4df3f 100644
--- a/src/main/java/org/apache/bcel/generic/ObjectType.java
+++ b/src/main/java/org/apache/bcel/generic/ObjectType.java
@@ -22,7 +22,7 @@ import org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Utility;
/**
- * Denotes reference such as java.lang.String.
+ * Denotes reference such as {@link String}.
*/
public class ObjectType extends ReferenceType {
@@ -42,7 +42,7 @@ public class ObjectType extends ReferenceType {
/**
* Constructs a new instance.
*
- * @param className fully qualified class name, e.g. java.lang.String
+ * @param className fully qualified class name, e.g. {@link String}
*/
public ObjectType(final String className) {
super(Const.T_REFERENCE, "L" + Utility.packageToPath(className) + ";");
diff --git a/src/main/java/org/apache/bcel/generic/ReferenceType.java b/src/main/java/org/apache/bcel/generic/ReferenceType.java
index 71f0d434..546bf0ae 100644
--- a/src/main/java/org/apache/bcel/generic/ReferenceType.java
+++ b/src/main/java/org/apache/bcel/generic/ReferenceType.java
@@ -56,8 +56,8 @@ public abstract class ReferenceType extends Type {
return this;
/*
* TODO: Above sounds a little arbitrary. On the other hand, there is no object referenced by Type.NULL so we can also
- * say all the objects referenced by Type.NULL were derived from java.lang.Object. However, the Java Language's
- * "instanceof" operator proves us wrong: "null" is not referring to an instance of java.lang.Object :)
+ * say all the objects referenced by Type.NULL were derived from {@link Object}. However, the Java Language's
+ * "instanceof" operator proves us wrong: "null" is not referring to an instance of {@link Object} :)
*/
}
if (this instanceof ArrayType || t instanceof ArrayType) {
@@ -87,8 +87,8 @@ public abstract class ReferenceType extends Type {
return this;
/*
* TODO: Above sounds a little arbitrary. On the other hand, there is no object referenced by Type.NULL so we can also
- * say all the objects referenced by Type.NULL were derived from java.lang.Object. However, the Java Language's
- * "instanceof" operator proves us wrong: "null" is not referring to an instance of java.lang.Object :)
+ * say all the objects referenced by Type.NULL were derived from {@link Object}. However, the Java Language's
+ * "instanceof" operator proves us wrong: "null" is not referring to an instance of {@link Object} :)
*/
}
/* This code is from a bug report by Konstantin Shagin <ko...@cs.technion.ac.il> */
diff --git a/src/main/java/org/apache/bcel/generic/Type.java b/src/main/java/org/apache/bcel/generic/Type.java
index 71b28383..76b83390 100644
--- a/src/main/java/org/apache/bcel/generic/Type.java
+++ b/src/main/java/org/apache/bcel/generic/Type.java
@@ -173,7 +173,7 @@ public abstract class Type {
}
/**
- * Convert runtime java.lang.Class to BCEL Type object.
+ * Convert runtime {@link Class} to BCEL Type object.
*
* @param cls Java class
* @return corresponding Type object
@@ -252,7 +252,7 @@ public abstract class Type {
}
/**
- * Convert runtime java.lang.Class[] to BCEL Type objects.
+ * Convert runtime {@code java.lang.Class[]} to BCEL Type objects.
*
* @param classes an array of runtime class objects
* @return array of corresponding Type objects
diff --git a/src/main/java/org/apache/bcel/verifier/VerifyDialog.java b/src/main/java/org/apache/bcel/verifier/VerifyDialog.java
index 9d316b02..88ef3b3f 100644
--- a/src/main/java/org/apache/bcel/verifier/VerifyDialog.java
+++ b/src/main/java/org/apache/bcel/verifier/VerifyDialog.java
@@ -178,9 +178,9 @@ public class VerifyDialog extends JDialog {
}
/**
- * Use this constructor if you want a possibility to verify other class files than java.lang.Object.
+ * Use this constructor if you want a possibility to verify other class files than {@link Object}.
*
- * @param fullyQualifiedClassName java.lang.String
+ * @param fullyQualifiedClassName "java.lang.String"
*/
public VerifyDialog(String fullyQualifiedClassName) {
final int dotclasspos = fullyQualifiedClassName.lastIndexOf(JavaClass.EXTENSION);
diff --git a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
index 810630eb..34f9f5f3 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
@@ -1321,7 +1321,7 @@ public final class Pass2Verifier extends PassVerifier implements Constants {
/**
* Ensures that every class has a super class and that <B>final</B> classes are not subclassed. This means, the class
- * this Pass2Verifier operates on has proper super classes (transitively) up to java.lang.Object. The reason for really
+ * this Pass2Verifier operates on has proper super classes (transitively) up to {@link Object}. The reason for really
* loading (and Pass1-verifying) all of those classes here is that we need them in Pass2 anyway to verify no final
* methods are overridden (that could be declared anywhere in the ancestor hierarchy).
*
diff --git a/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java b/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java
index b33e43bb..d501d097 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java
@@ -20,7 +20,7 @@ import org.apache.bcel.generic.InstructionHandle;
import org.apache.bcel.generic.ObjectType;
/**
- * This class represents an exception handler; that is, an ObjectType representing a subclass of java.lang.Throwable and
+ * This class represents an exception handler; that is, an ObjectType representing a subclass of {@link Throwable} and
* the instruction the handler starts off (represented by an InstructionContext).
*/
public class ExceptionHandler {
diff --git a/src/main/java/org/apache/bcel/verifier/structurals/GenericArray.java b/src/main/java/org/apache/bcel/verifier/structurals/GenericArray.java
index 4cd699ac..0fa6e412 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/GenericArray.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/GenericArray.java
@@ -20,7 +20,7 @@ import java.io.Serializable;
/**
* A placeholder class that can be used to create an ObjectType of which has some of the properties arrays have. They
- * implement java.lang.Cloneable and java.io.Serializable and they extend java.lang.Object.
+ * implement {@link Cloneable} and {@link java.io.Serializable} and they extend {@link Object}.
*/
public class GenericArray implements Cloneable, Serializable {