Adding and fixing javados.
Change-Id: I38eddb0b11630cdd83c5d1e5d5dc393ee2555897
diff --git a/cli/src/main/java/org/onosproject/cli/app/package-info.java b/cli/src/main/java/org/onosproject/cli/app/package-info.java
new file mode 100644
index 0000000..37b67fa
--- /dev/null
+++ b/cli/src/main/java/org/onosproject/cli/app/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * CLI commands for managing distributed inventory of applications.
+ */
+package org.onosproject.cli.app;
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/net/flow/package-info.java b/core/api/src/main/java/org/onosproject/net/flow/package-info.java
index 4264ee9..e17da4d 100644
--- a/core/api/src/main/java/org/onosproject/net/flow/package-info.java
+++ b/core/api/src/main/java/org/onosproject/net/flow/package-info.java
@@ -16,5 +16,11 @@
/**
* Flow rule model & related services API definitions.
+ *
+ * <p>
+ * The figure below depicts the general interactions between different
+ * components of the intent subsystem.<br>
+ * <img src="doc-files/flowrule-design.png" alt="ONOS flow rule subsystem design">
+ * </p>
*/
package org.onosproject.net.flow;
diff --git a/core/api/src/main/java/org/onosproject/net/group/package-info.java b/core/api/src/main/java/org/onosproject/net/group/package-info.java
new file mode 100644
index 0000000..26528c4
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/net/group/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Abstractions for interacting with device port groups.
+ */
+package org.onosproject.net.group;
\ No newline at end of file
diff --git a/core/api/src/main/java/org/onosproject/net/intent/package-info.java b/core/api/src/main/java/org/onosproject/net/intent/package-info.java
index 601d976..5aad747 100644
--- a/core/api/src/main/java/org/onosproject/net/intent/package-info.java
+++ b/core/api/src/main/java/org/onosproject/net/intent/package-info.java
@@ -75,7 +75,9 @@
* performs global recomputation/optimization across all prior intents.
* </p>
* <p>
- * <img src="doc-files/intent-subsystem.png" alt="ONOS intent subsystem">
+ * The figure below depicts the general interactions between different
+ * components of the intent subsystem.<br>
+ * <img src="doc-files/intent-design.png" alt="ONOS intent subsystem design">
* </p>
*/
package org.onosproject.net.intent;
diff --git a/core/api/src/main/javadoc/org/onosproject/net/flow/doc-files/flowrule-design.png b/core/api/src/main/javadoc/org/onosproject/net/flow/doc-files/flowrule-design.png
new file mode 100644
index 0000000..4392ad4
--- /dev/null
+++ b/core/api/src/main/javadoc/org/onosproject/net/flow/doc-files/flowrule-design.png
Binary files differ
diff --git a/core/api/src/main/javadoc/org/onosproject/net/intent/doc-files/intent-design.png b/core/api/src/main/javadoc/org/onosproject/net/intent/doc-files/intent-design.png
new file mode 100644
index 0000000..e08745d
--- /dev/null
+++ b/core/api/src/main/javadoc/org/onosproject/net/intent/doc-files/intent-design.png
Binary files differ
diff --git a/core/api/src/main/javadoc/org/onosproject/net/intent/doc-files/intent-subsystem.png b/core/api/src/main/javadoc/org/onosproject/net/intent/doc-files/intent-subsystem.png
deleted file mode 100644
index 616b2f8..0000000
--- a/core/api/src/main/javadoc/org/onosproject/net/intent/doc-files/intent-subsystem.png
+++ /dev/null
Binary files differ
diff --git a/core/store/dist/src/main/java/org/onosproject/store/consistent/impl/package-info.java b/core/store/dist/src/main/java/org/onosproject/store/consistent/impl/package-info.java
new file mode 100644
index 0000000..3dae86b
--- /dev/null
+++ b/core/store/dist/src/main/java/org/onosproject/store/consistent/impl/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Implementation of partitioned and distributed store facility capable of
+ * providing consistent update semantics.
+ */
+package org.onosproject.store.consistent.impl;
\ No newline at end of file
diff --git a/core/store/dist/src/main/java/org/onosproject/store/service/impl/package-info.java b/core/store/dist/src/main/java/org/onosproject/store/service/impl/package-info.java
new file mode 100644
index 0000000..c6013b3
--- /dev/null
+++ b/core/store/dist/src/main/java/org/onosproject/store/service/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Utility services and backing mechanisms for implementations of distributed stores.
+ */
+package org.onosproject.store.service.impl;
\ No newline at end of file
diff --git a/docs/external.xml b/docs/external.xml
index c730c90..30c3f9c 100644
--- a/docs/external.xml
+++ b/docs/external.xml
@@ -49,7 +49,7 @@
<version>2.10.1</version>
<configuration>
<show>package</show>
- <excludePackageNames>org.onlab.thirdparty:*.impl:*.impl.*:org.onosproject.provider.*:org.onosproject.gui:org.onosproject.rest:org.onosproject.cli*:org.onosproject.tvue:org.onosproject.foo:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.optical:org.onosproject.config:org.onosproject.calendar:org.onosproject.sdnip*:org.onosproject.oecfg:org.onosproject.metrics:org.onosproject.store.*:org.onosproject.openflow.*:org.onosproject.common.*</excludePackageNames>
+ <excludePackageNames>org.onlab.thirdparty:*.impl:*.impl.*:org.onosproject.provider.*:org.onosproject.gui:org.onosproject.rest:org.onosproject.cli*:org.onosproject.tvue:org.onosproject.foo:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.optical:org.onosproject.config:org.onosproject.calendar:org.onosproject.sdnip*:org.onosproject.oecfg:org.onosproject.metrics:org.onosproject.store.*:org.onosproject.openflow.*:org.onosproject.common.*:org.onosproject.net.group.impl</excludePackageNames>
<docfilessubdirs>true</docfilessubdirs>
<doctitle>ONOS Java API</doctitle>
<groups>
diff --git a/docs/pom.xml b/docs/pom.xml
index 3a1bfb9..eec3b1e 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -61,7 +61,7 @@
<group>
<title>Core Subsystems</title>
<packages>
- org.onosproject.impl:org.onosproject.core.impl:org.onosproject.cluster.impl:org.onosproject.net.device.impl:org.onosproject.net.link.impl:org.onosproject.net.host.impl:org.onosproject.net.topology.impl:org.onosproject.net.packet.impl:org.onosproject.net.flow.impl:org.onosproject.net.*.impl:org.onosproject.event.impl:org.onosproject.net.intent.impl:org.onosproject.net.proxyarp.impl:org.onosproject.mastership.impl:org.onosproject.net.resource.impl:org.onosproject.json:org.onosproject.json.*:org.onosproject.provider.host.impl:org.onosproject.provider.lldp.impl:org.onosproject.net.statistic.impl:org.onosproject.app.impl:org.onosproject.common.*
+ org.onosproject.impl:org.onosproject.core.impl:org.onosproject.cluster.impl:org.onosproject.net.device.impl:org.onosproject.net.link.impl:org.onosproject.net.host.impl:org.onosproject.net.topology.impl:org.onosproject.net.packet.impl:org.onosproject.net.flow.impl:org.onosproject.net.*.impl:org.onosproject.event.impl:org.onosproject.net.intent.impl:org.onosproject.net.proxyarp.impl:org.onosproject.mastership.impl:org.onosproject.net.resource.impl:org.onosproject.json:org.onosproject.json.*:org.onosproject.provider.host.impl:org.onosproject.provider.lldp.impl:org.onosproject.net.statistic.impl:org.onosproject.app.impl:org.onosproject.common.*:org.onosproject.net.group.impl
</packages>
</group>
<group>
@@ -78,6 +78,13 @@
</packages>
</group>
<group>
+ <title>Null Providers
+ </title>
+ <packages>
+ org.onosproject.provider.nil.*
+ </packages>
+ </group>
+ <group>
<title>Utilities</title>
<packages>
org.onlab.*
diff --git a/docs/src/main/javadoc/doc-files/onos-subsystems.png b/docs/src/main/javadoc/doc-files/onos-subsystems.png
new file mode 100644
index 0000000..a6100c5
--- /dev/null
+++ b/docs/src/main/javadoc/doc-files/onos-subsystems.png
Binary files differ
diff --git a/docs/src/main/javadoc/overview.html b/docs/src/main/javadoc/overview.html
index a3e32d9..d3712ab 100644
--- a/docs/src/main/javadoc/overview.html
+++ b/docs/src/main/javadoc/overview.html
@@ -39,7 +39,15 @@
</p>
<p>
- The following diagram describes a general structure of each ONOS subsystem:
+ The figure below provides a visual inventory of the various ONOS subsystems.
+ The ones with the gray outline represent either work in progress features
+ planned for release in 2015.<br>
+ <img src="doc-files/onos-subsystems.png" alt="ONOS architecture tiers">
+
+</p>
+
+<p>
+ The following diagram describes the general structure of each ONOS subsystem:
<br>
<img src="doc-files/onos-subsystem.png" alt="ONOS subsystem structure"><br>
For example, the device-subsystem comprises of a core
diff --git a/providers/null/device/src/main/java/org/onosproject/provider/nil/device/impl/package-info.java b/providers/null/device/src/main/java/org/onosproject/provider/nil/device/impl/package-info.java
index 03a1250..1d439b4 100644
--- a/providers/null/device/src/main/java/org/onosproject/provider/nil/device/impl/package-info.java
+++ b/providers/null/device/src/main/java/org/onosproject/provider/nil/device/impl/package-info.java
@@ -15,6 +15,6 @@
*/
/**
- * Null Provider that advertises fake devices.
+ * Provider that advertises fake devices.
*/
package org.onosproject.provider.nil.device.impl;
diff --git a/providers/null/flow/src/main/java/org/onosproject/provider/nil/flow/impl/package-info.java b/providers/null/flow/src/main/java/org/onosproject/provider/nil/flow/impl/package-info.java
index cd26203..8ebd2c4 100644
--- a/providers/null/flow/src/main/java/org/onosproject/provider/nil/flow/impl/package-info.java
+++ b/providers/null/flow/src/main/java/org/onosproject/provider/nil/flow/impl/package-info.java
@@ -15,6 +15,6 @@
*/
/**
- * Null provider that will accept any flow.
+ * Provider that will accept any flow rules.
*/
package org.onosproject.provider.nil.flow.impl;
diff --git a/providers/null/host/src/main/java/org/onosproject/provider/nil/host/impl/package-info.java b/providers/null/host/src/main/java/org/onosproject/provider/nil/host/impl/package-info.java
index 16ff2a5..3ef22e8 100644
--- a/providers/null/host/src/main/java/org/onosproject/provider/nil/host/impl/package-info.java
+++ b/providers/null/host/src/main/java/org/onosproject/provider/nil/host/impl/package-info.java
@@ -15,6 +15,6 @@
*/
/**
- * Null Provider that advertises fake hosts.
+ * Provider that advertises fake hosts.
*/
package org.onosproject.provider.nil.host.impl;
diff --git a/providers/null/packet/src/main/java/org/onosproject/provider/nil/packet/impl/package-info.java b/providers/null/packet/src/main/java/org/onosproject/provider/nil/packet/impl/package-info.java
index f29e200..8af5218 100644
--- a/providers/null/packet/src/main/java/org/onosproject/provider/nil/packet/impl/package-info.java
+++ b/providers/null/packet/src/main/java/org/onosproject/provider/nil/packet/impl/package-info.java
@@ -15,6 +15,6 @@
*/
/**
- * Provider that takes and brings to/from oblivion.
+ * Provider that sends and brings packets to & from oblivion.
*/
package org.onosproject.provider.nil.packet.impl;
diff --git a/providers/openflow/group/src/main/java/org/onosproject/provider/of/group/impl/package-info.java b/providers/openflow/group/src/main/java/org/onosproject/provider/of/group/impl/package-info.java
new file mode 100644
index 0000000..9fda4a3
--- /dev/null
+++ b/providers/openflow/group/src/main/java/org/onosproject/provider/of/group/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provider that uses OpenFlow controller as a means of device port group management.
+ */
+package org.onosproject.provider.of.group.impl;
\ No newline at end of file
