commit 99ff20ad3e5fd4af2b74af8fb89da8892f344b01
author Jonathan Hart <jono@onlab.us> Sun Jun 15 16:53:00 2014 -0700
committer Gerrit Code Review <gerrit2@gerrit.onos.onlab.us> Tue Jun 17 23:22:27 2014 -0700
tree c7e38e429de404fb095ed301710f9f39e29898ae
parent dc59c15aeeff2be01e741dcb4ec16adc0a1d9d9e

Cleaned up warnings reported by the Javadoc tool.

Javadoc reports warnings for things such as missing return descriptions,
missing or wrong parameters, invalid tags.

Note: I didn't touch any of the warnings in the OpenflowJ code.

Change-Id: I7234f617e092b489fad599196fc9cbe78f7e2db1

src/main/java/net/onrc/onos/core/flowprogrammer/FlowPusher.java

diff --git a/src/main/java/net/onrc/onos/core/flowprogrammer/FlowPusher.java b/src/main/java/net/onrc/onos/core/flowprogrammer/FlowPusher.java
index 1bf9ee6..a3ee412 100644
--- a/src/main/java/net/onrc/onos/core/flowprogrammer/FlowPusher.java
+++ b/src/main/java/net/onrc/onos/core/flowprogrammer/FlowPusher.java
@@ -977,7 +977,7 @@
      * @param sw
      * @param msg
      * @param priority
-     * @return
+     * @return true if the message was added successfully, otherwise false
      */
     protected boolean addMessageImpl(IOFSwitch sw, OFMessage msg, MsgPriority priority) {
         FlowPusherThread thread = getProcessingThread(sw);

src/main/java/net/onrc/onos/core/flowprogrammer/IFlowPusherService.java

diff --git a/src/main/java/net/onrc/onos/core/flowprogrammer/IFlowPusherService.java b/src/main/java/net/onrc/onos/core/flowprogrammer/IFlowPusherService.java
index 25b8044..c1b0c41 100644
--- a/src/main/java/net/onrc/onos/core/flowprogrammer/IFlowPusherService.java
+++ b/src/main/java/net/onrc/onos/core/flowprogrammer/IFlowPusherService.java
@@ -119,7 +119,6 @@
      *
      * @param sw        Switch to which message is pushed.
      * @param flowEntry FlowEntry object used for creating message.
-     * @return true if message is successfully added to a queue.
      */
     void pushFlowEntry(IOFSwitch sw, FlowEntry flowEntry);
 
@@ -132,7 +131,6 @@
      *
      * @param sw        Switch to which message is pushed.
      * @param flowEntry FlowEntry object used for creating message.
-     * @return true if message is successfully added to a queue.
      */
     void pushFlowEntry(IOFSwitch sw, FlowEntry flowEntry,
                        MsgPriority priority);