Fixed javadocs and descriptions.
Change-Id: I92147b858d8012c957cc03fab2d306740161e2f3
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 2d2102b..154127e 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 @@
/**
* 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 b8b1bd2..4556f7a 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -89,6 +89,12 @@
</packages>
</group>
<group>
+ <title>NetConf Providers</title>
+ <packages>
+ org.onosproject.provider.netconf:org.onosproject.provider.netconf*
+ </packages>
+ </group>
+ <group>
<title>Null Providers</title>
<packages>
org.onosproject.provider.nil:org.onosproject.provider.nil.*
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 2423de5..e0896be 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 @@
/**
* 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<S> 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 711279b..b660a9b 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 @@
* class of subject.
*
* @param subjectClass subject class
+ * @param <T> type of subject
+ * @return set of config factories
*/
<T> Set<ConfigFactory<T>> getConfigFactories(Class<T> subjectClass);
@@ -49,6 +51,9 @@
* subject type and key.
*
* @param subjectClass subject class
+ * @param configKey configuration key
+ * @param <T> type of subject
+ * @return config factory
*/
<T> ConfigFactory<T> getConfigFactory(Class<T> subjectClass, String configKey);
@@ -57,6 +62,8 @@
* configuration class.
*
* @param configClass configuration class
+ * @param <T> type of subject
+ * @return config factory
*/
<T> ConfigFactory<T> getConfigFactory(Class<Config<T>> 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 3dae379..65731da 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 @@
* Returns the set of subjects for which some configuration is available.
*
* @param subjectClass subject class
+ * @param <T> type of subject
* @return set of configured subjects
*/
<T> Set<T> getSubjects(Class<T> subjectClass);
@@ -38,6 +39,7 @@
*
* @param subjectClass subject class
* @param configClass configuration class
+ * @param <T> type of subject
* @return set of configured subjects
*/
<T> Set<T> getSubjects(Class<T> subjectClass, Class<Config<T>> configClass);
@@ -47,6 +49,7 @@
* Returns all configurations for the specified subject.
*
* @param subject configuration subject
+ * @param <T> type of subject
* @return set of configurations
*/
<T> Set<Config<T>> getConfigs(T subject);
@@ -57,6 +60,7 @@
*
* @param subject configuration subject
* @param configClass configuration class
+ * @param <T> type of subject
* @return configuration or null if one is not available
*/
<T> Config<T> getConfig(T subject, Class<Config<T>> 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 f626688..7b56b88 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 @@
/**
* 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 f846fbc..dc2f333 100644
--- a/providers/null/pom.xml
+++ b/providers/null/pom.xml
@@ -29,7 +29,7 @@
<artifactId>onos-null-provider</artifactId>
<packaging>bundle</packaging>
- <description>Null southbound providers application</description>
+ <description>Null southbound providers</description>
<properties>
<onos.app.name>org.onosproject.null</onos.app.name>
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 c24a8a5..1debdf2 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 @@
* 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 13c06ca..6902d22 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 @@
* 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 @@
/**
* Returns the set of resolved imports for this Java source
+ *
* @return set of imports
*/
public Set<JavaEntity> getImports() {
@@ -78,6 +80,7 @@
/**
* Returns the set of imported, but unresolved, Java entity names.
+ *
* @return set of imported Java entity names
*/
Set<String> getImportNames() {