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 f486849f Javadoc
f486849f is described below
commit f486849fbb5184efda73a50ca62a6d58389ef7a6
Author: Gary David Gregory (Code signing key) <[email protected]>
AuthorDate: Wed Nov 2 19:44:46 2022 -0400
Javadoc
---
src/main/java/org/apache/bcel/generic/InstructionConst.java | 13 +++++++------
.../java/org/apache/bcel/generic/InstructionConstants.java | 7 +++++--
2 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConst.java
b/src/main/java/org/apache/bcel/generic/InstructionConst.java
index 0064d295..8c9d9d74 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConst.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConst.java
@@ -19,22 +19,23 @@ package org.apache.bcel.generic;
import org.apache.bcel.Const;
/**
- * This interface contains shareable instruction objects.
- *
+ * Contains shareable instruction objects.
+ * <p>
* In order to save memory you can use some instructions multiply, since they
have an immutable state and are directly
* derived from Instruction. I.e. they have no instance fields that could be
changed. Since some of these instructions
* like ICONST_0 occur very frequently this can save a lot of time and space.
This feature is an adaptation of the
* FlyWeight design pattern, we just use an array instead of a factory.
- *
+ * </p>
+ * <p>
* The Instructions can also accessed directly under their names, so it's
possible to write
* il.append(Instruction.ICONST_0);
+ * </p>
*/
public final class InstructionConst {
/**
- * Predefined instruction objects
- */
- /*
+ * Predefined instruction objects.
+ *
* NOTE these are not currently immutable, because Instruction has mutable
protected fields opcode and length.
*/
public static final Instruction NOP = new NOP();
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConstants.java
b/src/main/java/org/apache/bcel/generic/InstructionConstants.java
index 345737b9..067556f7 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConstants.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConstants.java
@@ -17,7 +17,7 @@
package org.apache.bcel.generic;
/**
- * This interface contains shareable instruction objects.
+ * Contains shareable instruction objects.
* <p>
* In order to save memory you can use some instructions multiply, since they
have an immutable state and are directly
* derived from Instruction. I.e. they have no instance fields that could be
changed. Since some of these instructions
@@ -29,11 +29,14 @@ package org.apache.bcel.generic;
* il.append(Instruction.ICONST_0);
* </p>
*
- * @deprecated (since 6.0) Do not use. Use InstructionConst instead.
+ * @deprecated (since 6.0) Do not use. Use {@link InstructionConst} instead.
*/
@Deprecated
public interface InstructionConstants {
+ /**
+ * Deprecated, consider private and ignore.
+ */
class Clinit {}
/*
