Thomas Vachuska

Fixed javadocs and descriptions.

Change-Id: I92147b858d8012c957cc03fab2d306740161e2f3
...@@ -74,6 +74,8 @@ public class RoutingRulePopulator { ...@@ -74,6 +74,8 @@ public class RoutingRulePopulator {
74 74
75 /** 75 /**
76 * Returns the number of rules populated. 76 * Returns the number of rules populated.
77 + *
78 + * @return number of rules
77 */ 79 */
78 public long getCounter() { 80 public long getCounter() {
79 return rulePopulationCounter.get(); 81 return rulePopulationCounter.get();
......
...@@ -89,6 +89,12 @@ ...@@ -89,6 +89,12 @@
89 </packages> 89 </packages>
90 </group> 90 </group>
91 <group> 91 <group>
92 + <title>NetConf Providers</title>
93 + <packages>
94 + org.onosproject.provider.netconf:org.onosproject.provider.netconf*
95 + </packages>
96 + </group>
97 + <group>
92 <title>Null Providers</title> 98 <title>Null Providers</title>
93 <packages> 99 <packages>
94 org.onosproject.provider.nil:org.onosproject.provider.nil.* 100 org.onosproject.provider.nil:org.onosproject.provider.nil.*
......
...@@ -45,9 +45,10 @@ public abstract class Config<S> { ...@@ -45,9 +45,10 @@ public abstract class Config<S> {
45 /** 45 /**
46 * Initializes the configuration behaviour with necessary context. 46 * Initializes the configuration behaviour with necessary context.
47 * 47 *
48 - * @param subject configuration subject 48 + * @param subject configuration subject
49 - * @param node JSON object node where configuration data is stored 49 + * @param node JSON object node where configuration data is stored
50 - * @param mapper JSON object mapper 50 + * @param mapper JSON object mapper
51 + * @param delegate delegate context
51 */ 52 */
52 public void init(S subject, ObjectNode node, ObjectMapper mapper, 53 public void init(S subject, ObjectNode node, ObjectMapper mapper,
53 ConfigApplyDelegate<S> delegate) { 54 ConfigApplyDelegate<S> delegate) {
......
...@@ -41,6 +41,8 @@ public interface NetworkConfigRegistry { ...@@ -41,6 +41,8 @@ public interface NetworkConfigRegistry {
41 * class of subject. 41 * class of subject.
42 * 42 *
43 * @param subjectClass subject class 43 * @param subjectClass subject class
44 + * @param <T> type of subject
45 + * @return set of config factories
44 */ 46 */
45 <T> Set<ConfigFactory<T>> getConfigFactories(Class<T> subjectClass); 47 <T> Set<ConfigFactory<T>> getConfigFactories(Class<T> subjectClass);
46 48
...@@ -49,6 +51,9 @@ public interface NetworkConfigRegistry { ...@@ -49,6 +51,9 @@ public interface NetworkConfigRegistry {
49 * subject type and key. 51 * subject type and key.
50 * 52 *
51 * @param subjectClass subject class 53 * @param subjectClass subject class
54 + * @param configKey configuration key
55 + * @param <T> type of subject
56 + * @return config factory
52 */ 57 */
53 <T> ConfigFactory<T> getConfigFactory(Class<T> subjectClass, String configKey); 58 <T> ConfigFactory<T> getConfigFactory(Class<T> subjectClass, String configKey);
54 59
...@@ -57,6 +62,8 @@ public interface NetworkConfigRegistry { ...@@ -57,6 +62,8 @@ public interface NetworkConfigRegistry {
57 * configuration class. 62 * configuration class.
58 * 63 *
59 * @param configClass configuration class 64 * @param configClass configuration class
65 + * @param <T> type of subject
66 + * @return config factory
60 */ 67 */
61 <T> ConfigFactory<T> getConfigFactory(Class<Config<T>> configClass); 68 <T> ConfigFactory<T> getConfigFactory(Class<Config<T>> configClass);
62 69
......
...@@ -28,6 +28,7 @@ public interface NetworkConfigService { ...@@ -28,6 +28,7 @@ public interface NetworkConfigService {
28 * Returns the set of subjects for which some configuration is available. 28 * Returns the set of subjects for which some configuration is available.
29 * 29 *
30 * @param subjectClass subject class 30 * @param subjectClass subject class
31 + * @param <T> type of subject
31 * @return set of configured subjects 32 * @return set of configured subjects
32 */ 33 */
33 <T> Set<T> getSubjects(Class<T> subjectClass); 34 <T> Set<T> getSubjects(Class<T> subjectClass);
...@@ -38,6 +39,7 @@ public interface NetworkConfigService { ...@@ -38,6 +39,7 @@ public interface NetworkConfigService {
38 * 39 *
39 * @param subjectClass subject class 40 * @param subjectClass subject class
40 * @param configClass configuration class 41 * @param configClass configuration class
42 + * @param <T> type of subject
41 * @return set of configured subjects 43 * @return set of configured subjects
42 */ 44 */
43 <T> Set<T> getSubjects(Class<T> subjectClass, Class<Config<T>> configClass); 45 <T> Set<T> getSubjects(Class<T> subjectClass, Class<Config<T>> configClass);
...@@ -47,6 +49,7 @@ public interface NetworkConfigService { ...@@ -47,6 +49,7 @@ public interface NetworkConfigService {
47 * Returns all configurations for the specified subject. 49 * Returns all configurations for the specified subject.
48 * 50 *
49 * @param subject configuration subject 51 * @param subject configuration subject
52 + * @param <T> type of subject
50 * @return set of configurations 53 * @return set of configurations
51 */ 54 */
52 <T> Set<Config<T>> getConfigs(T subject); 55 <T> Set<Config<T>> getConfigs(T subject);
...@@ -57,6 +60,7 @@ public interface NetworkConfigService { ...@@ -57,6 +60,7 @@ public interface NetworkConfigService {
57 * 60 *
58 * @param subject configuration subject 61 * @param subject configuration subject
59 * @param configClass configuration class 62 * @param configClass configuration class
63 + * @param <T> type of subject
60 * @return configuration or null if one is not available 64 * @return configuration or null if one is not available
61 */ 65 */
62 <T> Config<T> getConfig(T subject, Class<Config<T>> configClass); 66 <T> Config<T> getConfig(T subject, Class<Config<T>> configClass);
......
...@@ -90,7 +90,10 @@ public class NetconfDevice { ...@@ -90,7 +90,10 @@ public class NetconfDevice {
90 90
91 /** 91 /**
92 * This will try to connect to NETCONF device and find all the capabilities. 92 * This will try to connect to NETCONF device and find all the capabilities.
93 + *
94 + * @throws Exception if unable to connect to the device
93 */ 95 */
96 + // FIXME: this should not be a generic Exception; perhaps wrap in some RuntimeException
94 public void init() throws Exception { 97 public void init() throws Exception {
95 try { 98 try {
96 if (sshConnection == null) { 99 if (sshConnection == null) {
......
...@@ -29,7 +29,7 @@ ...@@ -29,7 +29,7 @@
29 <artifactId>onos-null-provider</artifactId> 29 <artifactId>onos-null-provider</artifactId>
30 <packaging>bundle</packaging> 30 <packaging>bundle</packaging>
31 31
32 - <description>Null southbound providers application</description> 32 + <description>Null southbound providers</description>
33 33
34 <properties> 34 <properties>
35 <onos.app.name>org.onosproject.null</onos.app.name> 35 <onos.app.name>org.onosproject.null</onos.app.name>
......
...@@ -41,6 +41,7 @@ public class Catalog { ...@@ -41,6 +41,7 @@ public class Catalog {
41 * Loads the catalog from the specified catalog file. 41 * Loads the catalog from the specified catalog file.
42 * 42 *
43 * @param catalogPath catalog file path 43 * @param catalogPath catalog file path
44 + * @throws IOException if unable to read the catalog file
44 */ 45 */
45 public void load(String catalogPath) throws IOException { 46 public void load(String catalogPath) throws IOException {
46 InputStream is = new FileInputStream(catalogPath); 47 InputStream is = new FileInputStream(catalogPath);
......
...@@ -22,6 +22,7 @@ public class JavaSource extends JavaEntity { ...@@ -22,6 +22,7 @@ public class JavaSource extends JavaEntity {
22 * Creates a new Java source entity. 22 * Creates a new Java source entity.
23 * 23 *
24 * @param name java source file name 24 * @param name java source file name
25 + * @param path source file path
25 */ 26 */
26 JavaSource(String name, String path) { 27 JavaSource(String name, String path) {
27 super(name); 28 super(name);
...@@ -50,6 +51,7 @@ public class JavaSource extends JavaEntity { ...@@ -50,6 +51,7 @@ public class JavaSource extends JavaEntity {
50 51
51 /** 52 /**
52 * Returns the set of resolved imports for this Java source 53 * Returns the set of resolved imports for this Java source
54 + *
53 * @return set of imports 55 * @return set of imports
54 */ 56 */
55 public Set<JavaEntity> getImports() { 57 public Set<JavaEntity> getImports() {
...@@ -78,6 +80,7 @@ public class JavaSource extends JavaEntity { ...@@ -78,6 +80,7 @@ public class JavaSource extends JavaEntity {
78 80
79 /** 81 /**
80 * Returns the set of imported, but unresolved, Java entity names. 82 * Returns the set of imported, but unresolved, Java entity names.
83 + *
81 * @return set of imported Java entity names 84 * @return set of imported Java entity names
82 */ 85 */
83 Set<String> getImportNames() { 86 Set<String> getImportNames() {
......