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 2019/09/09 14:14:31 UTC
[commons-bcel] 01/03: 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
commit 9f44f41ed1761c2a6b5a8e76cf05e92f28715a36
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Sep 9 10:12:40 2019 -0400
Javadoc.
---
.github/workflows/maven.yml | 2 +-
src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java | 6 +++++-
src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java | 6 +++++-
src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java | 4 ++++
src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java | 1 +
.../java/org/apache/bcel/verifier/statics/StringRepresentation.java | 1 +
6 files changed, 17 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
index f90af52..03a18bb 100644
--- a/.github/workflows/maven.yml
+++ b/.github/workflows/maven.yml
@@ -32,4 +32,4 @@ jobs:
with:
java-version: ${{ matrix.java }}
- name: Build with Maven
- run: mvn -V package --file pom.xml
+ run: mvn -V apache-rat:check package --file pom.xml
diff --git a/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java b/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java
index 0c145a4..1874e51 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java
@@ -34,7 +34,11 @@ public final class DOUBLE_Upper extends Type{
super(Const.T_UNKNOWN, "Double_Upper");
}
- /** Use this method to get the single instance of this class. */
+ /**
+ * Gets the single instance of this class.
+ *
+ * @return the single instance of this class.
+ */
public static DOUBLE_Upper theInstance() {
return singleton;
}
diff --git a/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java b/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java
index 788b2b5..b0a27b2 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java
@@ -34,7 +34,11 @@ public final class LONG_Upper extends Type{
super(Const.T_UNKNOWN, "Long_Upper");
}
- /** Use this method to get the single instance of this class. */
+ /**
+ * Gets the single instance of this class.
+ *
+ * @return the single instance of this class.
+ */
public static LONG_Upper theInstance() {
return singleton;
}
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 c7e52c1..9b3ac9a 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
@@ -1541,13 +1541,17 @@ public final class Pass2Verifier extends PassVerifier implements Constants {
cp = jc.getConstantPool();
(new DescendingVisitor(jc, this)).visit();
}
+
/**
* Returns if the JavaClass this InnerClassDetector is working on
* has an Inner Class reference in its constant pool.
+ *
+ * @return Whether this InnerClassDetector is working on has an Inner Class reference in its constant pool.
*/
public boolean innerClassReferenced() {
return hasInnerClass;
}
+
/** This method casually visits ConstantClass references. */
@Override
public void visitConstantClass(final ConstantClass obj) {
diff --git a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
index 70ec589..3fee63d 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
@@ -126,6 +126,7 @@ public final class Pass3aVerifier extends PassVerifier{
* It's here for performance reasons by do_verify() and its callees.
*/
private InstructionList instructionList;
+
/**
* The one and only Code object used by an instance of this class.
* It's here for performance reasons by do_verify() and its callees.
diff --git a/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java b/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java
index 997bcb7..6081759 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java
@@ -88,6 +88,7 @@ public class StringRepresentation extends org.apache.bcel.classfile.EmptyVisitor
/**
* Creates a new StringRepresentation object which is the representation of n.
*
+ * @param n The node to represent.
* @see #toString()
*/
public StringRepresentation(final Node n) {