tom

Fixed a few javadocs.

...@@ -3,7 +3,7 @@ package org.onlab.onos.net; ...@@ -3,7 +3,7 @@ package org.onlab.onos.net;
3 import java.util.Set; 3 import java.util.Set;
4 4
5 /** 5 /**
6 - * Represents an set of simply key/value string annotations. 6 + * Represents an set of simple key/value string annotations.
7 */ 7 */
8 public interface Annotations { 8 public interface Annotations {
9 9
......
...@@ -3,7 +3,8 @@ package org.onlab.onos.net; ...@@ -3,7 +3,8 @@ package org.onlab.onos.net;
3 import java.util.Set; 3 import java.util.Set;
4 4
5 /** 5 /**
6 - * Represents an set of simply key/value string annotations. 6 + * Represents an set of sparse key/value string annotations capable of carrying
7 + * annotation keys tagged for removal.
7 */ 8 */
8 public interface SparseAnnotations extends Annotations { 9 public interface SparseAnnotations extends Annotations {
9 10
......
...@@ -12,8 +12,7 @@ public interface ProxyArpService { ...@@ -12,8 +12,7 @@ public interface ProxyArpService {
12 /** 12 /**
13 * Returns whether this particular ip address is known to the system. 13 * Returns whether this particular ip address is known to the system.
14 * 14 *
15 - * @param addr 15 + * @param addr a ip address
16 - * a ip address
17 * @return true if know, false otherwise 16 * @return true if know, false otherwise
18 */ 17 */
19 boolean known(IpPrefix addr); 18 boolean known(IpPrefix addr);
...@@ -22,14 +21,14 @@ public interface ProxyArpService { ...@@ -22,14 +21,14 @@ public interface ProxyArpService {
22 * Sends a reply for a given request. If the host is not known then the arp 21 * Sends a reply for a given request. If the host is not known then the arp
23 * will be flooded at all edge ports. 22 * will be flooded at all edge ports.
24 * 23 *
25 - * @param eth 24 + * @param eth an arp request
26 - * an arp request
27 */ 25 */
28 void reply(Ethernet eth); 26 void reply(Ethernet eth);
29 27
30 /** 28 /**
31 * Forwards an ARP request to its destination. Floods at the edge the ARP request if the 29 * Forwards an ARP request to its destination. Floods at the edge the ARP request if the
32 * destination is not known. 30 * destination is not known.
31 + *
33 * @param eth an ethernet frame containing an ARP request. 32 * @param eth an ethernet frame containing an ARP request.
34 */ 33 */
35 void forward(Ethernet eth); 34 void forward(Ethernet eth);
......