Thomas Vachuska
Committed by Gerrit Code Review

Cleaning up javadocs.

Change-Id: I67a0600fc80f9d7b0859f2e0e7634579cab6cfbf
...@@ -60,6 +60,7 @@ public class CordVtnArpProxy { ...@@ -60,6 +60,7 @@ public class CordVtnArpProxy {
60 * 60 *
61 * @param appId application id 61 * @param appId application id
62 * @param packetService packet service 62 * @param packetService packet service
63 + * @param hostService host service reference
63 */ 64 */
64 public CordVtnArpProxy(ApplicationId appId, PacketService packetService, HostService hostService) { 65 public CordVtnArpProxy(ApplicationId appId, PacketService packetService, HostService hostService) {
65 this.appId = appId; 66 this.appId = appId;
......
...@@ -96,6 +96,7 @@ public class OpenstackSwitchingRulePopulator { ...@@ -96,6 +96,7 @@ public class OpenstackSwitchingRulePopulator {
96 /** 96 /**
97 * Populates flow rules for the VM created. 97 * Populates flow rules for the VM created.
98 * 98 *
99 + * @param doNotPushFlow true to suppress push of initial flows
99 * @param device device to populate rules to 100 * @param device device to populate rules to
100 * @param port port for the VM created 101 * @param port port for the VM created
101 */ 102 */
...@@ -271,6 +272,7 @@ public class OpenstackSwitchingRulePopulator { ...@@ -271,6 +272,7 @@ public class OpenstackSwitchingRulePopulator {
271 /** 272 /**
272 * Remove flows rules for the removed VM. 273 * Remove flows rules for the removed VM.
273 * 274 *
275 + * @param doNotPushFlows true to suppress push of initial flows
274 * @param removedPort removedport info 276 * @param removedPort removedport info
275 * @param openstackPortInfoMap openstackPortInfoMap 277 * @param openstackPortInfoMap openstackPortInfoMap
276 */ 278 */
......
...@@ -35,7 +35,7 @@ public abstract class ConsistentMapBuilder<K, V> ...@@ -35,7 +35,7 @@ public abstract class ConsistentMapBuilder<K, V>
35 /** 35 /**
36 * Clears map contents when the owning application is uninstalled. 36 * Clears map contents when the owning application is uninstalled.
37 * 37 *
38 - * return this builder 38 + * @return this builder
39 */ 39 */
40 public ConsistentMapBuilder<K, V> withPurgeOnUninstall() { 40 public ConsistentMapBuilder<K, V> withPurgeOnUninstall() {
41 purgeOnUninstall = true; 41 purgeOnUninstall = true;
......
...@@ -34,7 +34,7 @@ public abstract class DistributedSetBuilder<E> extends DistributedPrimitiveBuild ...@@ -34,7 +34,7 @@ public abstract class DistributedSetBuilder<E> extends DistributedPrimitiveBuild
34 /** 34 /**
35 * Enables clearing set contents when the owning application is uninstalled. 35 * Enables clearing set contents when the owning application is uninstalled.
36 * 36 *
37 - * return this builder 37 + * @return this builder
38 */ 38 */
39 public DistributedSetBuilder<E> withPurgeOnUninstall() { 39 public DistributedSetBuilder<E> withPurgeOnUninstall() {
40 purgeOnUninstall = true; 40 purgeOnUninstall = true;
......
...@@ -76,6 +76,7 @@ final class ResourceDeviceListener implements DeviceListener { ...@@ -76,6 +76,7 @@ final class ResourceDeviceListener implements DeviceListener {
76 * Creates an instance with the specified ResourceAdminService and ExecutorService. 76 * Creates an instance with the specified ResourceAdminService and ExecutorService.
77 * 77 *
78 * @param adminService instance invoked to register resources 78 * @param adminService instance invoked to register resources
79 + * @param resourceService {@link ResourceService} to be used
79 * @param deviceService {@link DeviceService} to be used 80 * @param deviceService {@link DeviceService} to be used
80 * @param driverService {@link DriverService} to be used 81 * @param driverService {@link DriverService} to be used
81 * @param netcfgService {@link NetworkConfigService} to be used. 82 * @param netcfgService {@link NetworkConfigService} to be used.
......
...@@ -36,7 +36,9 @@ public class TransactionCoordinator { ...@@ -36,7 +36,9 @@ public class TransactionCoordinator {
36 36
37 /** 37 /**
38 * Commits a transaction. 38 * Commits a transaction.
39 + *
39 * @param transactionId transaction 40 * @param transactionId transaction
41 + * @param transactionParticipants set of transaction participants
40 * @return future for commit result 42 * @return future for commit result
41 */ 43 */
42 CompletableFuture<Void> commit(TransactionId transactionId, Set<TransactionParticipant> transactionParticipants) { 44 CompletableFuture<Void> commit(TransactionId transactionId, Set<TransactionParticipant> transactionParticipants) {
......
...@@ -107,11 +107,11 @@ public class NewAdaptiveFlowStatsCollector { ...@@ -107,11 +107,11 @@ public class NewAdaptiveFlowStatsCollector {
107 /** 107 /**
108 * Creates a new adaptive collector for the given switch and default cal_and_poll frequency. 108 * Creates a new adaptive collector for the given switch and default cal_and_poll frequency.
109 * 109 *
110 + * @param driverService driver service reference
110 * @param sw switch to pull 111 * @param sw switch to pull
111 * @param pollInterval cal and immediate poll frequency in seconds 112 * @param pollInterval cal and immediate poll frequency in seconds
112 */ 113 */
113 - NewAdaptiveFlowStatsCollector( 114 + NewAdaptiveFlowStatsCollector(DriverService driverService, OpenFlowSwitch sw, int pollInterval) {
114 - DriverService driverService, OpenFlowSwitch sw, int pollInterval) {
115 this.driverService = driverService; 115 this.driverService = driverService;
116 this.sw = sw; 116 this.sw = sw;
117 initMemberVars(pollInterval); 117 initMemberVars(pollInterval);
......
...@@ -42,8 +42,8 @@ final class RestDeviceProviderUtilities { ...@@ -42,8 +42,8 @@ final class RestDeviceProviderUtilities {
42 * connection with any SSL protected device that ONOS has an interaction with. 42 * connection with any SSL protected device that ONOS has an interaction with.
43 * Needs addressing for secutirty purposes. 43 * Needs addressing for secutirty purposes.
44 * 44 *
45 - * @throws NoSuchAlgorithmException 45 + * @throws NoSuchAlgorithmException if algorithm specified is not available
46 - * @throws KeyManagementException 46 + * @throws KeyManagementException if unable to use the key
47 */ 47 */
48 //FIXME redo for security purposes. 48 //FIXME redo for security purposes.
49 protected static void enableSslCert() throws NoSuchAlgorithmException, KeyManagementException { 49 protected static void enableSslCert() throws NoSuchAlgorithmException, KeyManagementException {
......