diff --git a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/RoutingRulePopulator.java b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/RoutingRulePopulator.java index 2d2102bbb3..154127e72d 100644 --- a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/RoutingRulePopulator.java +++ b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/RoutingRulePopulator.java @@ -74,6 +74,8 @@ public class RoutingRulePopulator { /** * Returns the number of rules populated. + * + * @return number of rules */ public long getCounter() { return rulePopulationCounter.get(); diff --git a/docs/pom.xml b/docs/pom.xml index b8b1bd2699..4556f7a514 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -88,6 +88,12 @@ org.onosproject.provider.of.*:org.onosproject.openflow.* + + NetConf Providers + + org.onosproject.provider.netconf:org.onosproject.provider.netconf* + + Null Providers diff --git a/exp/api/src/main/java/org/onosproject/exp/net/config/Config.java b/exp/api/src/main/java/org/onosproject/exp/net/config/Config.java index 2423de5b03..e0896be5c9 100644 --- a/exp/api/src/main/java/org/onosproject/exp/net/config/Config.java +++ b/exp/api/src/main/java/org/onosproject/exp/net/config/Config.java @@ -45,9 +45,10 @@ public abstract class Config { /** * Initializes the configuration behaviour with necessary context. * - * @param subject configuration subject - * @param node JSON object node where configuration data is stored - * @param mapper JSON object mapper + * @param subject configuration subject + * @param node JSON object node where configuration data is stored + * @param mapper JSON object mapper + * @param delegate delegate context */ public void init(S subject, ObjectNode node, ObjectMapper mapper, ConfigApplyDelegate delegate) { diff --git a/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigRegistry.java b/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigRegistry.java index 711279b617..b660a9bca3 100644 --- a/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigRegistry.java +++ b/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigRegistry.java @@ -41,6 +41,8 @@ public interface NetworkConfigRegistry { * class of subject. * * @param subjectClass subject class + * @param type of subject + * @return set of config factories */ Set> getConfigFactories(Class subjectClass); @@ -49,6 +51,9 @@ public interface NetworkConfigRegistry { * subject type and key. * * @param subjectClass subject class + * @param configKey configuration key + * @param type of subject + * @return config factory */ ConfigFactory getConfigFactory(Class subjectClass, String configKey); @@ -57,6 +62,8 @@ public interface NetworkConfigRegistry { * configuration class. * * @param configClass configuration class + * @param type of subject + * @return config factory */ ConfigFactory getConfigFactory(Class> configClass); diff --git a/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigService.java b/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigService.java index 3dae379f2e..65731dae91 100644 --- a/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigService.java +++ b/exp/api/src/main/java/org/onosproject/exp/net/config/NetworkConfigService.java @@ -28,6 +28,7 @@ public interface NetworkConfigService { * Returns the set of subjects for which some configuration is available. * * @param subjectClass subject class + * @param type of subject * @return set of configured subjects */ Set getSubjects(Class subjectClass); @@ -38,6 +39,7 @@ public interface NetworkConfigService { * * @param subjectClass subject class * @param configClass configuration class + * @param type of subject * @return set of configured subjects */ Set getSubjects(Class subjectClass, Class> configClass); @@ -47,6 +49,7 @@ public interface NetworkConfigService { * Returns all configurations for the specified subject. * * @param subject configuration subject + * @param type of subject * @return set of configurations */ Set> getConfigs(T subject); @@ -57,6 +60,7 @@ public interface NetworkConfigService { * * @param subject configuration subject * @param configClass configuration class + * @param type of subject * @return configuration or null if one is not available */ Config getConfig(T subject, Class> configClass); diff --git a/providers/netconf/device/src/main/java/org/onosproject/provider/netconf/device/impl/NetconfDevice.java b/providers/netconf/device/src/main/java/org/onosproject/provider/netconf/device/impl/NetconfDevice.java index f626688ba8..7b56b8865b 100644 --- a/providers/netconf/device/src/main/java/org/onosproject/provider/netconf/device/impl/NetconfDevice.java +++ b/providers/netconf/device/src/main/java/org/onosproject/provider/netconf/device/impl/NetconfDevice.java @@ -90,7 +90,10 @@ public class NetconfDevice { /** * This will try to connect to NETCONF device and find all the capabilities. + * + * @throws Exception if unable to connect to the device */ + // FIXME: this should not be a generic Exception; perhaps wrap in some RuntimeException public void init() throws Exception { try { if (sshConnection == null) { diff --git a/providers/null/pom.xml b/providers/null/pom.xml index f846fbcfe4..dc2f33300a 100644 --- a/providers/null/pom.xml +++ b/providers/null/pom.xml @@ -29,7 +29,7 @@ onos-null-provider bundle - Null southbound providers application + Null southbound providers org.onosproject.null diff --git a/utils/jdvue/src/main/java/org/onlab/jdvue/Catalog.java b/utils/jdvue/src/main/java/org/onlab/jdvue/Catalog.java index c24a8a59c2..1debdf25c8 100644 --- a/utils/jdvue/src/main/java/org/onlab/jdvue/Catalog.java +++ b/utils/jdvue/src/main/java/org/onlab/jdvue/Catalog.java @@ -41,6 +41,7 @@ public class Catalog { * Loads the catalog from the specified catalog file. * * @param catalogPath catalog file path + * @throws IOException if unable to read the catalog file */ public void load(String catalogPath) throws IOException { InputStream is = new FileInputStream(catalogPath); diff --git a/utils/jdvue/src/main/java/org/onlab/jdvue/JavaSource.java b/utils/jdvue/src/main/java/org/onlab/jdvue/JavaSource.java index 13c06ca936..6902d22b49 100644 --- a/utils/jdvue/src/main/java/org/onlab/jdvue/JavaSource.java +++ b/utils/jdvue/src/main/java/org/onlab/jdvue/JavaSource.java @@ -22,6 +22,7 @@ public class JavaSource extends JavaEntity { * Creates a new Java source entity. * * @param name java source file name + * @param path source file path */ JavaSource(String name, String path) { super(name); @@ -50,6 +51,7 @@ public class JavaSource extends JavaEntity { /** * Returns the set of resolved imports for this Java source + * * @return set of imports */ public Set getImports() { @@ -78,6 +80,7 @@ public class JavaSource extends JavaEntity { /** * Returns the set of imported, but unresolved, Java entity names. + * * @return set of imported Java entity names */ Set getImportNames() {