Thomas Vachuska

Adding and fixing javados.

Change-Id: I38eddb0b11630cdd83c5d1e5d5dc393ee2555897
/*
* 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
......@@ -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;
......
/*
* 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
......@@ -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;
......
/*
* 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
/*
* 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
......@@ -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>
......
......@@ -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.*
......
......@@ -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
......
......@@ -15,6 +15,6 @@
*/
/**
* Null Provider that advertises fake devices.
* Provider that advertises fake devices.
*/
package org.onosproject.provider.nil.device.impl;
......
......@@ -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;
......
......@@ -15,6 +15,6 @@
*/
/**
* Null Provider that advertises fake hosts.
* Provider that advertises fake hosts.
*/
package org.onosproject.provider.nil.host.impl;
......
......@@ -15,6 +15,6 @@
*/
/**
* Provider that takes and brings to/from oblivion.
* Provider that sends and brings packets to &amp; from oblivion.
*/
package org.onosproject.provider.nil.packet.impl;
......
/*
* 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