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 11c0418b Fix Javadoc warnings
11c0418b is described below
commit 11c0418bd04a7a029572b8fb74ed497029b000bd
Author: Gary David Gregory (Code signing key) <ggreg...@apache.org>
AuthorDate: Tue Feb 4 11:23:46 2025 -0500
Fix Javadoc warnings
---
src/examples/ClassDumper.java | 20 ++++++++++----------
.../org/apache/bcel/classfile/RecordTestCase.java | 4 ++--
.../java/org/apache/bcel/data/ConstantPoolX.java | 2 +-
3 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/examples/ClassDumper.java b/src/examples/ClassDumper.java
index e902114e..efd943cb 100644
--- a/src/examples/ClassDumper.java
+++ b/src/examples/ClassDumper.java
@@ -68,7 +68,7 @@ final class ClassDumper {
* fields and commands. A <em>ClassFormatException</em> is raised, if the
file is not a valid .class file. (This does
* not include verification of the byte code as it is performed by the
Java interpreter).
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
public void dump() throws IOException, ClassFormatException {
@@ -104,7 +104,7 @@ final class ClassDumper {
/**
* Processes information about the attributes of the class.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processAttributes() throws IOException, ClassFormatException {
@@ -126,7 +126,7 @@ final class ClassDumper {
/**
* Processes information about the class and its super class.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processClassInfo() throws IOException, ClassFormatException {
@@ -158,7 +158,7 @@ final class ClassDumper {
/**
* Processes constant pool entries.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processConstantPool() throws IOException,
ClassFormatException {
@@ -194,7 +194,7 @@ final class ClassDumper {
* Constructs object from file stream.
*
* @param file Input stream
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processFieldOrMethod() throws IOException,
ClassFormatException {
@@ -243,7 +243,7 @@ final class ClassDumper {
/**
* Processes information about the fields of the class, i.e., its
variables.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processFields() throws IOException, ClassFormatException {
@@ -264,7 +264,7 @@ final class ClassDumper {
/**
* Checks whether the header of the file is ok. Of course, this has to be
the first action on successive file reads.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processID() throws IOException, ClassFormatException {
@@ -281,7 +281,7 @@ final class ClassDumper {
/**
* Processes information about the interfaces implemented by this class.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processInterfaces() throws IOException, ClassFormatException {
@@ -307,7 +307,7 @@ final class ClassDumper {
/**
* Processes information about the methods of the class.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processMethods() throws IOException, ClassFormatException {
@@ -327,7 +327,7 @@ final class ClassDumper {
/**
* Processes major and minor version of compiler which created the file.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
private void processVersion() throws IOException, ClassFormatException {
diff --git a/src/test/java/org/apache/bcel/classfile/RecordTestCase.java
b/src/test/java/org/apache/bcel/classfile/RecordTestCase.java
index 74abbb36..3c7206c7 100644
--- a/src/test/java/org/apache/bcel/classfile/RecordTestCase.java
+++ b/src/test/java/org/apache/bcel/classfile/RecordTestCase.java
@@ -79,7 +79,7 @@ public class RecordTestCase extends AbstractTestCase {
* marked such that we can determine from the access flags
* (through BCEL) that it is in fact a record.
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
* @throws ClassFormatException
*/
@Test
@@ -96,7 +96,7 @@ public class RecordTestCase extends AbstractTestCase {
*
* @throws ClassNotFoundException
* @throws ClassFormatException
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
*/
@Test
public void testRecordToString() throws ClassNotFoundException,
ClassFormatException, IOException {
diff --git a/src/test/java/org/apache/bcel/data/ConstantPoolX.java
b/src/test/java/org/apache/bcel/data/ConstantPoolX.java
index a31df8d2..99778a63 100644
--- a/src/test/java/org/apache/bcel/data/ConstantPoolX.java
+++ b/src/test/java/org/apache/bcel/data/ConstantPoolX.java
@@ -182,7 +182,7 @@ public abstract class ConstantPoolX implements Cloneable,
Node {
* Dump constant pool to file stream in binary format.
*
* @param file Output file stream
- * @throws IOException
+ * @throws IOException if an I/O error occurs.
*/
public void dump(final DataOutputStream file) throws IOException {
file.writeShort(constantPool.length);
