홍길동 / onos

Go to a project
Toggle navigation Toggle navigation pinning
Sho SHIMIZU
bdaea831 1 parent ba5621e3

Follow javadoc convention 

Change-Id: I8c6a99289225033a48b815053a7e5213fd1aeb9c
Inline Side-by-side
Showing 2 changed files with 22 additions and 0 deletions
...@@ -60,6 +60,7 @@ public interface TrafficSelector { ...@@ -60,6 +60,7 @@ public interface TrafficSelector {
60 60
61 /** 61 /**
62 * Matches an inport. 62 * Matches an inport.
63 + *
63 * @param port the inport 64 * @param port the inport
64 * @return a selection builder 65 * @return a selection builder
65 */ 66 */
...@@ -67,6 +68,7 @@ public interface TrafficSelector { ...@@ -67,6 +68,7 @@ public interface TrafficSelector {
67 68
68 /** 69 /**
69 * Matches a l2 src address. 70 * Matches a l2 src address.
71 + *
70 * @param addr a l2 address 72 * @param addr a l2 address
71 * @return a selection builder 73 * @return a selection builder
72 */ 74 */
...@@ -74,6 +76,7 @@ public interface TrafficSelector { ...@@ -74,6 +76,7 @@ public interface TrafficSelector {
74 76
75 /** 77 /**
76 * Matches a l2 dst address. 78 * Matches a l2 dst address.
79 + *
77 * @param addr a l2 address 80 * @param addr a l2 address
78 * @return a selection builder 81 * @return a selection builder
79 */ 82 */
...@@ -81,6 +84,7 @@ public interface TrafficSelector { ...@@ -81,6 +84,7 @@ public interface TrafficSelector {
81 84
82 /** 85 /**
83 * Matches the ethernet type. 86 * Matches the ethernet type.
87 + *
84 * @param ethType an ethernet type 88 * @param ethType an ethernet type
85 * @return a selection builder 89 * @return a selection builder
86 */ 90 */
...@@ -88,6 +92,7 @@ public interface TrafficSelector { ...@@ -88,6 +92,7 @@ public interface TrafficSelector {
88 92
89 /** 93 /**
90 * Matches the vlan id. 94 * Matches the vlan id.
95 + *
91 * @param vlanId a vlan id 96 * @param vlanId a vlan id
92 * @return a selection builder 97 * @return a selection builder
93 */ 98 */
...@@ -95,6 +100,7 @@ public interface TrafficSelector { ...@@ -95,6 +100,7 @@ public interface TrafficSelector {
95 100
96 /** 101 /**
97 * Matches a vlan priority. 102 * Matches a vlan priority.
103 + *
98 * @param vlanPcp a vlan priority 104 * @param vlanPcp a vlan priority
99 * @return a selection builder 105 * @return a selection builder
100 */ 106 */
...@@ -102,6 +108,7 @@ public interface TrafficSelector { ...@@ -102,6 +108,7 @@ public interface TrafficSelector {
102 108
103 /** 109 /**
104 * Matches the l3 protocol. 110 * Matches the l3 protocol.
111 + *
105 * @param proto a l3 protocol 112 * @param proto a l3 protocol
106 * @return a selection builder 113 * @return a selection builder
107 */ 114 */
...@@ -109,6 +116,7 @@ public interface TrafficSelector { ...@@ -109,6 +116,7 @@ public interface TrafficSelector {
109 116
110 /** 117 /**
111 * Matches a l3 address. 118 * Matches a l3 address.
119 + *
112 * @param ip a l3 address 120 * @param ip a l3 address
113 * @return a selection builder 121 * @return a selection builder
114 */ 122 */
...@@ -116,6 +124,7 @@ public interface TrafficSelector { ...@@ -116,6 +124,7 @@ public interface TrafficSelector {
116 124
117 /** 125 /**
118 * Matches a l3 address. 126 * Matches a l3 address.
127 + *
119 * @param ip a l3 address 128 * @param ip a l3 address
120 * @return a selection builder 129 * @return a selection builder
121 */ 130 */
...@@ -123,6 +132,7 @@ public interface TrafficSelector { ...@@ -123,6 +132,7 @@ public interface TrafficSelector {
123 132
124 /** 133 /**
125 * Matches a TCP source port number. 134 * Matches a TCP source port number.
135 + *
126 * @param tcpPort a TCP source port number 136 * @param tcpPort a TCP source port number
127 * @return a selection builder 137 * @return a selection builder
128 */ 138 */
...@@ -130,6 +140,7 @@ public interface TrafficSelector { ...@@ -130,6 +140,7 @@ public interface TrafficSelector {
130 140
131 /** 141 /**
132 * Matches a TCP destination port number. 142 * Matches a TCP destination port number.
143 + *
133 * @param tcpPort a TCP destination port number 144 * @param tcpPort a TCP destination port number
134 * @return a selection builder 145 * @return a selection builder
135 */ 146 */
...@@ -137,6 +148,7 @@ public interface TrafficSelector { ...@@ -137,6 +148,7 @@ public interface TrafficSelector {
137 148
138 /** 149 /**
139 * Matches an optical signal ID or lambda. 150 * Matches an optical signal ID or lambda.
151 + *
140 * @param lambda lamda 152 * @param lambda lamda
141 * @return a selection builder 153 * @return a selection builder
142 */ 154 */
...@@ -144,6 +156,7 @@ public interface TrafficSelector { ...@@ -144,6 +156,7 @@ public interface TrafficSelector {
144 156
145 /** 157 /**
146 * Matches an optical Signal Type. 158 * Matches an optical Signal Type.
159 + *
147 * @param signalType signalType 160 * @param signalType signalType
148 * @return a selection builder 161 * @return a selection builder
149 */ 162 */
......
...@@ -42,6 +42,7 @@ public interface TrafficTreatment { ...@@ -42,6 +42,7 @@ public interface TrafficTreatment {
42 42
43 /** 43 /**
44 * Adds an instruction to the builder. 44 * Adds an instruction to the builder.
45 + *
45 * @param instruction an instruction 46 * @param instruction an instruction
46 * @return a treatment builder 47 * @return a treatment builder
47 */ 48 */
...@@ -54,6 +55,7 @@ public interface TrafficTreatment { ...@@ -54,6 +55,7 @@ public interface TrafficTreatment {
54 55
55 /** 56 /**
56 * Set the output port. 57 * Set the output port.
58 + *
57 * @param number the out port 59 * @param number the out port
58 * @return a treatment builder 60 * @return a treatment builder
59 */ 61 */
...@@ -61,6 +63,7 @@ public interface TrafficTreatment { ...@@ -61,6 +63,7 @@ public interface TrafficTreatment {
61 63
62 /** 64 /**
63 * Sets the src l2 address. 65 * Sets the src l2 address.
66 + *
64 * @param addr a macaddress 67 * @param addr a macaddress
65 * @return a treatment builder 68 * @return a treatment builder
66 */ 69 */
...@@ -68,6 +71,7 @@ public interface TrafficTreatment { ...@@ -68,6 +71,7 @@ public interface TrafficTreatment {
68 71
69 /** 72 /**
70 * Sets the dst l2 address. 73 * Sets the dst l2 address.
74 + *
71 * @param addr a macaddress 75 * @param addr a macaddress
72 * @return a treatment builder 76 * @return a treatment builder
73 */ 77 */
...@@ -75,6 +79,7 @@ public interface TrafficTreatment { ...@@ -75,6 +79,7 @@ public interface TrafficTreatment {
75 79
76 /** 80 /**
77 * Sets the vlan id. 81 * Sets the vlan id.
82 + *
78 * @param id a vlanid 83 * @param id a vlanid
79 * @return a treatment builder 84 * @return a treatment builder
80 */ 85 */
...@@ -82,6 +87,7 @@ public interface TrafficTreatment { ...@@ -82,6 +87,7 @@ public interface TrafficTreatment {
82 87
83 /** 88 /**
84 * Sets the vlan priority. 89 * Sets the vlan priority.
90 + *
85 * @param pcp a vlan priority 91 * @param pcp a vlan priority
86 * @return a treatment builder 92 * @return a treatment builder
87 */ 93 */
...@@ -89,6 +95,7 @@ public interface TrafficTreatment { ...@@ -89,6 +95,7 @@ public interface TrafficTreatment {
89 95
90 /** 96 /**
91 * Sets the src l3 address. 97 * Sets the src l3 address.
98 + *
92 * @param addr an ip 99 * @param addr an ip
93 * @return a treatment builder 100 * @return a treatment builder
94 */ 101 */
...@@ -96,6 +103,7 @@ public interface TrafficTreatment { ...@@ -96,6 +103,7 @@ public interface TrafficTreatment {
96 103
97 /** 104 /**
98 * Sets the dst l3 address. 105 * Sets the dst l3 address.
106 + *
99 * @param addr an ip 107 * @param addr an ip
100 * @return a treatment builder 108 * @return a treatment builder
101 */ 109 */
...@@ -103,6 +111,7 @@ public interface TrafficTreatment { ...@@ -103,6 +111,7 @@ public interface TrafficTreatment {
103 111
104 /** 112 /**
105 * Sets the optical channel ID or lambda. 113 * Sets the optical channel ID or lambda.
114 + *
106 * @param lambda optical channel ID 115 * @param lambda optical channel ID
107 * @return a treatment builder 116 * @return a treatment builder
108 */ 117 */
......