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/05/19 13:00:23 UTC
[commons-bcel] branch master updated: Javadoc: Use paragraph tags.
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 1d16de4 Javadoc: Use paragraph tags.
1d16de4 is described below
commit 1d16de4af937a1ad004c1f856e594fb89392a7e2
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Sun May 19 09:00:19 2019 -0400
Javadoc: Use paragraph tags.
---
src/examples/ProxyCreator.java | 6 ++++--
src/examples/TransitiveHull.java | 7 +++++--
src/examples/listclass.java | 5 ++++-
.../java/org/apache/bcel/generic/InstructionComparator.java | 5 ++++-
src/main/java/org/apache/bcel/generic/InstructionList.java | 4 +++-
src/main/java/org/apache/bcel/util/ClassLoader.java | 5 +++--
src/main/java/org/apache/bcel/util/ClassPathRepository.java | 2 +-
src/main/java/org/apache/bcel/util/JavaWrapper.java | 10 ++++++----
.../apache/bcel/util/MemorySensitiveClassPathRepository.java | 2 +-
src/main/java/org/apache/bcel/util/SyntheticRepository.java | 4 +++-
10 files changed, 34 insertions(+), 16 deletions(-)
diff --git a/src/examples/ProxyCreator.java b/src/examples/ProxyCreator.java
index 065c2f2..10be153 100644
--- a/src/examples/ProxyCreator.java
+++ b/src/examples/ProxyCreator.java
@@ -42,9 +42,11 @@ import org.apache.bcel.generic.Type;
* The trick is to encode the byte code we need into the class name
* using the Utility.encode() method. This will result however in big
* ugly class name, so for many cases it will be more sufficient to
- * put some clever creation code into the class loader.<br> This is
- * comparable to the mechanism provided via
+ * put some clever creation code into the class loader.
+ * <p>
+ * This is comparable to the mechanism provided via
* {@code java.lang.reflect.Proxy}, but much more flexible.
+ * </p>
*
* @see org.apache.bcel.util.JavaWrapper
* @see Utility
diff --git a/src/examples/TransitiveHull.java b/src/examples/TransitiveHull.java
index 03710a8..02d8809 100644
--- a/src/examples/TransitiveHull.java
+++ b/src/examples/TransitiveHull.java
@@ -40,15 +40,18 @@ import org.apache.bcel.util.ClassSet;
* Find all classes referenced by given start class and all classes referenced
* by those and so on. In other words: Compute the transitive hull of classes
* used by a given class. This is done by checking all ConstantClass entries and
- * all method and field signatures.<br>
+ * all method and field signatures.
+ * <p>
* This may be useful in order to put all class files of an application into a
* single JAR file, e.g..
+ * </p>
* <p>
* It fails however in the presence of reflexive code aka introspection.
+ * </p>
* <p>
* You'll need Apache's regular expression library supplied together with BCEL
* to use this class.
- *
+ * </p>
*/
public class TransitiveHull extends org.apache.bcel.classfile.EmptyVisitor {
diff --git a/src/examples/listclass.java b/src/examples/listclass.java
index a58f93b..43e52f0 100644
--- a/src/examples/listclass.java
+++ b/src/examples/listclass.java
@@ -62,7 +62,9 @@ import org.apache.bcel.classfile.Method;
* <li>{@code -nocontents} Do not print JavaClass.toString() for the class. I added
* this because sometimes I'm only interested in dependency information.</li>
* </ul>
- * <p>Here's a couple examples of how I typically use listclass:<br>
+ * <p>
+ * Here's a couple examples of how I typically use listclass:
+ * </p>
* <pre>java listclass -code MyClass</pre>
* Print information about the class and the byte code of the methods
* <pre>java listclass -nocontents -dependencies MyClass</pre>
@@ -71,6 +73,7 @@ import org.apache.bcel.classfile.Method;
* Print a recursive listing of all classes which MyClass depends on. Do not
* analyze classes beginning with "java.", "javax.", or "sun.".
* <pre>java listclass -nocontents -dependencies -recurse MyClass -exclude java.javax. sun.</pre>
+ * <p>
* Print a recursive listing of dependency information for MyClass and its
* dependents. Do not analyze classes beginning with "java.", "javax.", or "sun."
* </p>
diff --git a/src/main/java/org/apache/bcel/generic/InstructionComparator.java b/src/main/java/org/apache/bcel/generic/InstructionComparator.java
index f2fb893..9cb7f0a 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionComparator.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionComparator.java
@@ -21,10 +21,13 @@ package org.apache.bcel.generic;
* Equality of instructions isn't clearly to be defined. You might
* wish, for example, to compare whether instructions have the same
* meaning. E.g., whether two INVOKEVIRTUALs describe the same
- * call.<br>The DEFAULT comparator however, considers two instructions
+ * call.
+ * <p>
+ * The DEFAULT comparator however, considers two instructions
* to be equal if they have same opcode and point to the same indexes
* (if any) in the constant pool or the same local variable index. Branch
* instructions must have the same target.
+ * </p>
*
* @see Instruction
*/
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java b/src/main/java/org/apache/bcel/generic/InstructionList.java
index 503af78..2727d3e 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -603,8 +603,10 @@ public class InstructionList implements Iterable<InstructionHandle> {
/**
* Take all instructions (handles) from "start" to "end" and append them after the new location "target". Of course, "end" must be after "start" and target
- * must not be located withing this range. If you want to move something to the start of the list use null as value for target.<br>
+ * must not be located withing this range. If you want to move something to the start of the list use null as value for target.
+ * <p>
* Any instruction targeters pointing to handles within the block, keep their targets.
+ * </p>
*
* @param start
* of moved block
diff --git a/src/main/java/org/apache/bcel/util/ClassLoader.java b/src/main/java/org/apache/bcel/util/ClassLoader.java
index 88b2182..f63b43a 100644
--- a/src/main/java/org/apache/bcel/util/ClassLoader.java
+++ b/src/main/java/org/apache/bcel/util/ClassLoader.java
@@ -159,11 +159,12 @@ public class ClassLoader extends java.lang.ClassLoader {
* token is considered to be a package name. You can encode your own
* arguments into the subsequent string. You must ensure however not
* to use any "illegal" characters, i.e., characters that may not
- * appear in a Java class name too<br>
- *
+ * appear in a Java class name too
+ * <p>
* The default implementation interprets the string as a encoded compressed
* Java class, unpacks and decodes it with the Utility.decode() method, and
* parses the resulting byte array and returns the resulting JavaClass object.
+ * </p>
*
* @param class_name compressed byte code with "$$BCEL$$" in it
*/
diff --git a/src/main/java/org/apache/bcel/util/ClassPathRepository.java b/src/main/java/org/apache/bcel/util/ClassPathRepository.java
index f58d1b1..251277c 100644
--- a/src/main/java/org/apache/bcel/util/ClassPathRepository.java
+++ b/src/main/java/org/apache/bcel/util/ClassPathRepository.java
@@ -27,7 +27,7 @@ import org.apache.bcel.classfile.JavaClass;
/**
* This repository is used in situations where a Class is created outside the realm of a ClassLoader. Classes are loaded from the file systems using the paths
- * specified in the given class path. By default, this is the value returned by ClassPath.getClassPath(). <br>
+ * specified in the given class path. By default, this is the value returned by ClassPath.getClassPath().
*
* @see org.apache.bcel.Repository
*/
diff --git a/src/main/java/org/apache/bcel/util/JavaWrapper.java b/src/main/java/org/apache/bcel/util/JavaWrapper.java
index d3b6f63..cbe6d51 100644
--- a/src/main/java/org/apache/bcel/util/JavaWrapper.java
+++ b/src/main/java/org/apache/bcel/util/JavaWrapper.java
@@ -23,12 +23,14 @@ import java.lang.reflect.Modifier;
/**
* Java interpreter replacement, i.e., wrapper that uses its own ClassLoader
* to modify/generate classes as they're requested. You can take this as a template
- * for your own applications.<br>
+ * for your own applications.
+ * <p>
* Call this wrapper with:
- *
+ * </p>
* <pre>java org.apache.bcel.util.JavaWrapper <real.class.name> [arguments]</pre>
- *
- * <p>To use your own class loader you can set the "bcel.classloader" system property<p>
+ * <p>
+ * To use your own class loader you can set the "bcel.classloader" system property.
+ * </p>
* <pre>java org.apache.bcel.util.JavaWrapper -Dbcel.classloader=foo.MyLoader <real.class.name> [arguments]</pre>
*
* @see ClassLoader
diff --git a/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java b/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java
index 4251d03..88b19a8 100644
--- a/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java
+++ b/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java
@@ -29,7 +29,7 @@ import org.apache.bcel.classfile.JavaClass;
/**
* This repository is used in situations where a Class is created outside the realm of a ClassLoader. Classes are loaded from the file systems using the paths
* specified in the given class path. By default, this is the value returned by ClassPath.getClassPath(). This repository holds onto classes with
- * SoftReferences, and will reload as needed, in cases where memory sizes are important.<br>
+ * SoftReferences, and will reload as needed, in cases where memory sizes are important.
*
* @see org.apache.bcel.Repository
*/
diff --git a/src/main/java/org/apache/bcel/util/SyntheticRepository.java b/src/main/java/org/apache/bcel/util/SyntheticRepository.java
index d8c7d5d..f5c0b86 100644
--- a/src/main/java/org/apache/bcel/util/SyntheticRepository.java
+++ b/src/main/java/org/apache/bcel/util/SyntheticRepository.java
@@ -22,9 +22,11 @@ import java.util.Map;
/**
* This repository is used in situations where a Class is created outside the realm of a ClassLoader. Classes are loaded from the file systems using the paths
- * specified in the given class path. By default, this is the value returned by ClassPath.getClassPath(). <br>
+ * specified in the given class path. By default, this is the value returned by ClassPath.getClassPath().
+ * <p>
* This repository uses a factory design, allowing it to maintain a collection of different classpaths, and as such It is designed to be used as a singleton per
* classpath.
+ * </p>
*
* @see org.apache.bcel.Repository
*