[commons-bcel] 01/02: Javadoc and use 120 line width.

[gg...@apache.org]

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 a8e1dcfeda52b16a5ab99aa5c887053f0f4b7414
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Sep 9 10:35:13 2019 -0400

    Javadoc and use 120 line width.
---
 .../bcel/verifier/structurals/Subroutine.java      | 60 +++++++++++-----------
 1 file changed, 31 insertions(+), 29 deletions(-)

diff --git a/src/main/java/org/apache/bcel/verifier/structurals/Subroutine.java b/src/main/java/org/apache/bcel/verifier/structurals/Subroutine.java
index 5fea235..ee6cffd 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Subroutine.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Subroutine.java
@@ -17,72 +17,74 @@
  */
 package org.apache.bcel.verifier.structurals;
 
-
 import org.apache.bcel.generic.InstructionHandle;
 
 /**
- * This interface defines properties of JVM bytecode subroutines.
- * Note that it is 'abused' to maintain the top-level code in a
- * consistent fashion, too.
+ * This interface defines properties of JVM bytecode subroutines. Note that it is 'abused' to maintain the top-level
+ * code in a consistent fashion, too.
  *
  */
-public interface Subroutine{
+public interface Subroutine {
     /**
-     * Returns all the JsrInstructions that have the
-     * first instruction of this subroutine as their target.
-     * <B>Must not be invoked on the 'top-level subroutine'.</B>
+     * Returns all the JsrInstructions that have the first instruction of this subroutine as their target. <B>Must not
+     * be invoked on the 'top-level subroutine'.</B>
+     * 
+     * @return The JsrInstructions that have the first instruction of this subroutine as their target.
      */
     InstructionHandle[] getEnteringJsrInstructions();
 
     /**
-     * Returns the one and only RET that leaves the subroutine.
-     * Note that JustIce has a pretty rigid notion of a subroutine.
-     * <B>Must not be invoked on the 'top-level subroutine'.</B>
+     * Returns the one and only RET that leaves the subroutine. Note that JustIce has a pretty rigid notion of a
+     * subroutine. <B>Must not be invoked on the 'top-level subroutine'.</B>
+     * 
+     * @return The one and only RET that leaves the subroutine.
      *
      * @see Subroutines
      */
     InstructionHandle getLeavingRET();
 
     /**
-     * Returns all instructions that together form this subroutine.
-     * Note that an instruction is part of exactly one subroutine
-     * (the top-level code is considered to be a special subroutine) -
-     * else it is not reachable at all (dead code).
+     * Returns all instructions that together form this subroutine. Note that an instruction is part of exactly one
+     * subroutine (the top-level code is considered to be a special subroutine) - else it is not reachable at all (dead
+     * code).
+     * 
+     * @return All instructions that together form this subroutine.
      */
     InstructionHandle[] getInstructions();
 
     /**
-     * Returns if the given InstructionHandle refers to an instruction
-     * that is part of this subroutine. This is a convenience method
-     * that saves iteration over the InstructionHandle objects returned
-     * by getInstructions().
+     * Returns if the given InstructionHandle refers to an instruction that is part of this subroutine. This is a
+     * convenience method that saves iteration over the InstructionHandle objects returned by getInstructions().
+     * 
+     * @param inst The InstructionHandle to test.
+     * @return Whether the given InstructionHandle refers to an instruction that is part of this subroutine.
      *
      * @see #getInstructions()
      */
     boolean contains(InstructionHandle inst);
 
     /**
-     * Returns an int[] containing the indices of the local variable slots
-     * accessed by this Subroutine (read-accessed, write-accessed or both);
-     * local variables referenced by subroutines of this subroutine are
-     * not included.
-     *
+     * Returns an int[] containing the indices of the local variable slots accessed by this Subroutine (read-accessed,
+     * write-accessed or both); local variables referenced by subroutines of this subroutine are not included.
+     * 
+     * @return An int[] containing the indices of the local variable slots.
      * @see #getRecursivelyAccessedLocalsIndices()
      */
     int[] getAccessedLocalsIndices();
 
     /**
-     * Returns an int[] containing the indices of the local variable slots
-     * accessed by this Subroutine (read-accessed, write-accessed or both);
-     * local variables referenced by subroutines of this subroutine are
-     * included.
-     *
+     * Returns an int[] containing the indices of the local variable slots accessed by this Subroutine (read-accessed,
+     * write-accessed or both); local variables referenced by subroutines of this subroutine are included.
+     * 
+     * @return An int[] containing the indices of the local variable slots.
      * @see #getAccessedLocalsIndices()
      */
     int[] getRecursivelyAccessedLocalsIndices();
 
     /**
      * Returns the subroutines that are directly called from this subroutine.
+     * 
+     * @return The subroutines that are directly called from this subroutine.
      */
     Subroutine[] subSubs();
 }