Fixed javadocs.
Change-Id: I6c0e5f59138ee024a858994a290da75a0f54a71f
Showing
3 changed files
with
6 additions
and
1 deletions
... | @@ -27,6 +27,9 @@ import static com.google.common.base.Preconditions.checkNotNull; | ... | @@ -27,6 +27,9 @@ import static com.google.common.base.Preconditions.checkNotNull; |
27 | */ | 27 | */ |
28 | public final class TunnelPolicy implements Policy { | 28 | public final class TunnelPolicy implements Policy { |
29 | 29 | ||
30 | + // FIXME: We should avoid passing around references to implementation objects | ||
31 | + // Instead, if some operational context is required, we should abstract it to | ||
32 | + // a bare minimum. | ||
30 | private final SegmentRoutingManager srManager; | 33 | private final SegmentRoutingManager srManager; |
31 | private final Type type; | 34 | private final Type type; |
32 | private final String id; | 35 | private final String id; |
... | @@ -61,6 +64,7 @@ public final class TunnelPolicy implements Policy { | ... | @@ -61,6 +64,7 @@ public final class TunnelPolicy implements Policy { |
61 | /** | 64 | /** |
62 | * Creates a TunnelPolicy reference. | 65 | * Creates a TunnelPolicy reference. |
63 | * | 66 | * |
67 | + * @param srm reference to the segment routing component | ||
64 | * @param p TunnelPolicy reference | 68 | * @param p TunnelPolicy reference |
65 | */ | 69 | */ |
66 | public TunnelPolicy(SegmentRoutingManager srm, TunnelPolicy p) { | 70 | public TunnelPolicy(SegmentRoutingManager srm, TunnelPolicy p) { | ... | ... |
... | @@ -141,7 +141,7 @@ public final class Frequency implements RichComparable<Frequency> { | ... | @@ -141,7 +141,7 @@ public final class Frequency implements RichComparable<Frequency> { |
141 | /** | 141 | /** |
142 | * Returns a Frequency whose value is Math.floorDiv(this, value). | 142 | * Returns a Frequency whose value is Math.floorDiv(this, value). |
143 | * | 143 | * |
144 | - * @param value | 144 | + * @param value value to be divided by this Frequency |
145 | * @return Math.floorDiv(this, value) | 145 | * @return Math.floorDiv(this, value) |
146 | */ | 146 | */ |
147 | public Frequency floorDivision(long value) { | 147 | public Frequency floorDivision(long value) { | ... | ... |
... | @@ -100,6 +100,7 @@ public class IOLoopMessaging implements MessagingService { | ... | @@ -100,6 +100,7 @@ public class IOLoopMessaging implements MessagingService { |
100 | /** | 100 | /** |
101 | * Activates IO Loops. | 101 | * Activates IO Loops. |
102 | * | 102 | * |
103 | + * @param localEp local end-point | ||
103 | * @throws IOException is activation fails | 104 | * @throws IOException is activation fails |
104 | */ | 105 | */ |
105 | public void start(Endpoint localEp) throws IOException { | 106 | public void start(Endpoint localEp) throws IOException { | ... | ... |
-
Please register or login to post a comment