aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenedikt Ritter <britter@apache.org>2017-08-28 19:03:22 +0000
committerBenedikt Ritter <britter@apache.org>2017-08-28 19:03:22 +0000
commitce846a4386c292f929000dbe31c3d31f5f0b3f71 (patch)
treef977bde50c14c96fa47a2efc476c22ed154310f6
parent99fcc3ba37e462efb65924bdf4a7538675f532a4 (diff)
downloadapache-commons-bcel-ce846a4386c292f929000dbe31c3d31f5f0b3f71.tar.gz
Better JavaDoc formatting
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/bcel/trunk@1806488 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--src/main/java/org/apache/bcel/Const.java90
-rw-r--r--src/site/resources/profile.clirr0
2 files changed, 62 insertions, 28 deletions
diff --git a/src/main/java/org/apache/bcel/Const.java b/src/main/java/org/apache/bcel/Const.java
index 5a7471e3..2423811b 100644
--- a/src/main/java/org/apache/bcel/Const.java
+++ b/src/main/java/org/apache/bcel/Const.java
@@ -277,44 +277,60 @@ public final class Const {
* References below are to the individual sections
*/
- /** Marks a constant pool entry as type UTF-8.
+ /**
+ * Marks a constant pool entry as type UTF-8.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.7">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_Utf8 = 1;
- /** Marks a constant pool entry as type Integer.
+ /**
+ * Marks a constant pool entry as type Integer.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.4">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_Integer = 3;
- /** Marks a constant pool entry as type Float.
+ /**
+ * Marks a constant pool entry as type Float.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.4">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_Float = 4;
- /** Marks a constant pool entry as type Long.
+ /**
+ * Marks a constant pool entry as type Long.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.5">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_Long = 5;
- /** Marks a constant pool entry as type Double.
+ /**
+ * Marks a constant pool entry as type Double.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.5">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_Double = 6;
- /** Marks a constant pool entry as a Class
+ /**
+ * Marks a constant pool entry as a Class
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.1">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_Class = 7;
- /** Marks a constant pool entry as a Field Reference.
+ /**
+ * Marks a constant pool entry as a Field Reference.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.2">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_Fieldref = 9;
- /** Marks a constant pool entry as type String
+ /**
+ * Marks a constant pool entry as type String
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.3">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_String = 8;
/** Marks a constant pool entry as a Method Reference.
@@ -322,9 +338,11 @@ public final class Const {
* The Constant Pool in The Java Virtual Machine Specification</a> */
public static final byte CONSTANT_Methodref = 10;
- /** Marks a constant pool entry as an Interface Method Reference.
+ /**
+ * Marks a constant pool entry as an Interface Method Reference.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.2">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_InterfaceMethodref = 11;
/** Marks a constant pool entry as a name and type.
@@ -332,31 +350,47 @@ public final class Const {
* The Constant Pool in The Java Virtual Machine Specification</a> */
public static final byte CONSTANT_NameAndType = 12;
- /** Marks a constant pool entry as a Method Handle.
+ /**
+ * Marks a constant pool entry as a Method Handle.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.8">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_MethodHandle = 15;
- /** Marks a constant pool entry as a Method Type.
+ /**
+ * Marks a constant pool entry as a Method Type.
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.9">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_MethodType = 16;
- /** Marks a constant pool entry as an Invoke Dynamic
+ /**
+ * Marks a constant pool entry as an Invoke Dynamic
* @see <a href="http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.4.10">
- * The Constant Pool in The Java Virtual Machine Specification</a> */
+ * The Constant Pool in The Java Virtual Machine Specification</a>
+ */
public static final byte CONSTANT_InvokeDynamic = 18;
- /** Marks a constant pool entry as a Module Reference.
+ /**
+ * Marks a constant pool entry as a Module Reference.
+ *
+ * <p>Note: Early access Java 9 support- currently subject to change</p>
+ *
* @see <a href="http://cr.openjdk.java.net/~mr/jigsaw/spec/lang-vm.html#jigsaw-2.6">
* JPMS: Modules in the Java Language and JVM</a>
- * Note: Early access Java 9 support- currently subject to change */
+ * @since 6.1
+ */
public static final byte CONSTANT_Module = 19;
- /** Marks a constant pool entry as a Package Reference.
+ /**
+ * Marks a constant pool entry as a Package Reference.
+ *
+ * <p>Note: Early access Java 9 support- currently subject to change</p>
+ *
* @see <a href="http://cr.openjdk.java.net/~mr/jigsaw/spec/lang-vm.html#jigsaw-2.6">
* JPMS: Modules in the Java Language and JVM</a>
- * Note: Early access Java 9 support- currently subject to change */
+ * @since 6.1
+ */
public static final byte CONSTANT_Package = 20;
/**
diff --git a/src/site/resources/profile.clirr b/src/site/resources/profile.clirr
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/src/site/resources/profile.clirr