Fixed a number of javadoc warnings and cleaned up aggregate javadocs.
Showing
5 changed files
with
15 additions
and
5 deletions
... | @@ -32,6 +32,7 @@ public class TestMessage extends AbstractMessage { | ... | @@ -32,6 +32,7 @@ public class TestMessage extends AbstractMessage { |
32 | /** | 32 | /** |
33 | * Creates a new message with the specified data. | 33 | * Creates a new message with the specified data. |
34 | * | 34 | * |
35 | + * @param length message length | ||
35 | * @param requestorTime requester time | 36 | * @param requestorTime requester time |
36 | * @param responderTime responder time | 37 | * @param responderTime responder time |
37 | * @param padding message padding | 38 | * @param padding message padding | ... | ... |
... | @@ -68,6 +68,7 @@ public abstract class ConnectivityIntentCompiler<T extends ConnectivityIntent> | ... | @@ -68,6 +68,7 @@ public abstract class ConnectivityIntentCompiler<T extends ConnectivityIntent> |
68 | * Validates the specified path against the given constraints. | 68 | * Validates the specified path against the given constraints. |
69 | * | 69 | * |
70 | * @param path path to be checked | 70 | * @param path path to be checked |
71 | + * @param constraints path constraints | ||
71 | * @return true if the path passes all constraints | 72 | * @return true if the path passes all constraints |
72 | */ | 73 | */ |
73 | protected boolean checkPath(Path path, List<Constraint> constraints) { | 74 | protected boolean checkPath(Path path, List<Constraint> constraints) { |
... | @@ -82,6 +83,7 @@ public abstract class ConnectivityIntentCompiler<T extends ConnectivityIntent> | ... | @@ -82,6 +83,7 @@ public abstract class ConnectivityIntentCompiler<T extends ConnectivityIntent> |
82 | /** | 83 | /** |
83 | * Computes a path between two ConnectPoints. | 84 | * Computes a path between two ConnectPoints. |
84 | * | 85 | * |
86 | + * @param intent intent on which behalf path is being computed | ||
85 | * @param one start of the path | 87 | * @param one start of the path |
86 | * @param two end of the path | 88 | * @param two end of the path |
87 | * @return Path between the two | 89 | * @return Path between the two | ... | ... |
... | @@ -250,6 +250,7 @@ public class DefaultTopology extends AbstractModel implements Topology { | ... | @@ -250,6 +250,7 @@ public class DefaultTopology extends AbstractModel implements Topology { |
250 | * | 250 | * |
251 | * @param src source device | 251 | * @param src source device |
252 | * @param dst destination device | 252 | * @param dst destination device |
253 | + * @param weight link weight function | ||
253 | * @return set of shortest paths | 254 | * @return set of shortest paths |
254 | */ | 255 | */ |
255 | Set<Path> getPaths(DeviceId src, DeviceId dst, LinkWeight weight) { | 256 | Set<Path> getPaths(DeviceId src, DeviceId dst, LinkWeight weight) { | ... | ... |
... | @@ -87,7 +87,13 @@ | ... | @@ -87,7 +87,13 @@ |
87 | <group> | 87 | <group> |
88 | <title>Sample Applications</title> | 88 | <title>Sample Applications</title> |
89 | <packages> | 89 | <packages> |
90 | - org.onlab.onos.tvue:org.onlab.onos.fwd:org.onlab.onos.ifwd:org.onlab.onos.mobility:org.onlab.onos.proxyarp:org.onlab.onos.foo:org.onlab.onos.calendar:org.onlab.onos.sdnip:org.onlab.onos.sdnip.*:org.onlab.onos.optical:org.onlab.onos.optical.*:org.onlab.onos.metrics.*:org.onlab.onos.config | 90 | + org.onlab.onos.tvue:org.onlab.onos.fwd:org.onlab.onos.ifwd:org.onlab.onos.mobility:org.onlab.onos.proxyarp:org.onlab.onos.foo:org.onlab.onos.calendar:org.onlab.onos.optical.*:org.onlab.onos.sdnip:org.onlab.onos.sdnip.*:org.onlab.onos.config |
91 | + </packages> | ||
92 | + </group> | ||
93 | + <group> | ||
94 | + <title>Test Instrumentation</title> | ||
95 | + <packages> | ||
96 | + org.onlab.onos.metrics.*:org.onlab.onos.oecfg | ||
91 | </packages> | 97 | </packages> |
92 | </group> | 98 | </group> |
93 | </groups> | 99 | </groups> | ... | ... |
... | @@ -115,7 +115,7 @@ class OFChannelHandler extends IdleStateAwareChannelHandler { | ... | @@ -115,7 +115,7 @@ class OFChannelHandler extends IdleStateAwareChannelHandler { |
115 | 115 | ||
116 | /** | 116 | /** |
117 | * Create a new unconnected OFChannelHandler. | 117 | * Create a new unconnected OFChannelHandler. |
118 | - * @param controller | 118 | + * @param controller parent controller |
119 | */ | 119 | */ |
120 | OFChannelHandler(Controller controller) { | 120 | OFChannelHandler(Controller controller) { |
121 | this.controller = controller; | 121 | this.controller = controller; |
... | @@ -794,7 +794,7 @@ class OFChannelHandler extends IdleStateAwareChannelHandler { | ... | @@ -794,7 +794,7 @@ class OFChannelHandler extends IdleStateAwareChannelHandler { |
794 | * @param m The PortStatus message we received | 794 | * @param m The PortStatus message we received |
795 | * @param doNotify if true switch port changed events will be | 795 | * @param doNotify if true switch port changed events will be |
796 | * dispatched | 796 | * dispatched |
797 | - * @throws SwitchStateException | 797 | + * @throws SwitchStateException if the switch is not bound to the channel |
798 | * | 798 | * |
799 | */ | 799 | */ |
800 | protected void handlePortStatusMessage(OFChannelHandler h, OFPortStatus m, | 800 | protected void handlePortStatusMessage(OFChannelHandler h, OFPortStatus m, |
... | @@ -826,8 +826,8 @@ class OFChannelHandler extends IdleStateAwareChannelHandler { | ... | @@ -826,8 +826,8 @@ class OFChannelHandler extends IdleStateAwareChannelHandler { |
826 | * | 826 | * |
827 | * @param h The OFChannelHandler that received the message | 827 | * @param h The OFChannelHandler that received the message |
828 | * @param m The message we received. | 828 | * @param m The message we received. |
829 | - * @throws SwitchStateException | 829 | + * @throws SwitchStateException if the switch is not bound to the channel |
830 | - * @throws IOException | 830 | + * @throws IOException if unable to send message back to the switch |
831 | */ | 831 | */ |
832 | void processOFMessage(OFChannelHandler h, OFMessage m) | 832 | void processOFMessage(OFChannelHandler h, OFMessage m) |
833 | throws IOException, SwitchStateException { | 833 | throws IOException, SwitchStateException { | ... | ... |
-
Please register or login to post a comment