garydgregory commented on a change in pull request #37: Improve documentation
of Pass3bVerifier
URL: https://github.com/apache/commons-bcel/pull/37#discussion_r354627927
##########
File path:
src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
##########
@@ -74,26 +74,68 @@
* time, an InstructionContext object will get the current information
* we have about its symbolic execution predecessors.
*/
- private static final class InstructionContextQueue{
+ private static final class InstructionContextQueue {
+ // The following two fields together represent the queue.
+ /** The first elements from pairs in the queue. */
private final List<InstructionContext> ics = new Vector<>();
+ /** The second elements from pairs in the queue. */
private final List<ArrayList<InstructionContext>> ecs = new Vector<>();
+
+ /**
+ * Add an (InstructionContext, ExecutionChain) pair to their
respective queues.
+ *
+ * @param ic the InstructionContext
+ * @param executionChain the ExecutionChain
+ */
public void add(final InstructionContext ic, final
ArrayList<InstructionContext> executionChain) {
ics.add(ic);
ecs.add(executionChain);
}
+
+ /**
+ * Test if InstructionContext queue is empty.
+ *
+ * @return true if the InstructionContext queue is empty.
+ */
public boolean isEmpty() {
return ics.isEmpty();
}
+
+ /**
+ * Remove a specific (InstructionContext, ExecutionChain) pair from
their respective queues.
+ *
+ * @param i the index of the items to be removed
+ */
public void remove(final int i) {
ics.remove(i);
ecs.remove(i);
}
+
+ /**
+ * Fetch a specific InstructionContext from the queue.
Review comment:
The method is a "getter", therefore should start its Javadoc with "Gets ...".
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
