From 84e09fb9c74b64255366a36bfc03e3611ec6be5b Mon Sep 17 00:00:00 2001 From: Thomas Vachuska Date: Wed, 17 Feb 2016 10:57:05 -0800 Subject: [PATCH] Cleaning up and re-organizing javadocs; it's time to start splitting this up more. Change-Id: If8752593ff30c9afbd43638590cff81fbcb80e7d --- docs/external-apps | 5 +++ docs/external-excludes | 22 ++++++++++++-- docs/external.xml | 6 +++- docs/internal-apps | 8 +++-- docs/internal-bgpls | 3 +- docs/internal-drivers | 3 +- docs/internal-excludes | 1 + docs/internal-ospf | 1 + docs/internal-pcep | 1 + docs/internal-providers | 1 + docs/internal.xml | 67 +++++++++++++++++++++++------------------ 11 files changed, 79 insertions(+), 39 deletions(-) create mode 100644 docs/external-apps create mode 100644 docs/internal-ospf diff --git a/docs/external-apps b/docs/external-apps new file mode 100644 index 0000000000..b2e4d89ca9 --- /dev/null +++ b/docs/external-apps @@ -0,0 +1,5 @@ +org.onosproject.dhcp +org.onosproject.cpman +org.onosproject.olt +org.onosproject.openstackswitching +org.onosproject.routing diff --git a/docs/external-excludes b/docs/external-excludes index da130e7cad..dade4d4f84 100644 --- a/docs/external-excludes +++ b/docs/external-excludes @@ -1,5 +1,6 @@ *.impl *.impl.* +protobuf.* org.onlab.jdvue* org.onlab.stc* @@ -10,7 +11,6 @@ org.onosproject.provider* org.onosproject.rest org.onosproject.cli* org.onosproject.tvue -org.onosproject.dhcp org.onosproject.foo org.onosproject.mobility org.onosproject.proxyarp @@ -27,7 +27,6 @@ org.onosproject.store.flow org.onosproject.store.serializers* org.onosproject.openflow* org.onosproject.common* -org.onosproject.routing* org.onosproject.bgprouter org.onosproject.intentperf org.onosproject.maven @@ -43,9 +42,25 @@ org.onosproject.demo* org.onosproject.xosintegration* org.onosproject.app.vtn* org.onosproject.ovsdb* +org.onosproject.bgp* org.onosproject.pcep* org.onosproject.aaa org.onosproject.acl* +org.onosproject.olt.* +org.onosproject.cpman.* +org.onosproject.pathpainter* +org.onosproject.openstackswitching.* +org.onosproject.openstackrouting* +org.onosproject.protocol* +org.onosproject.sfc* +org.onosproject.vrouter* +org.onosproject.vpls* +org.onosproject.netconf* +org.onosproject.security.store* +org.onosproject.faultmanagement* +org.onosproject.iptopology* +org.onosproject.igmp* +org.onosproject.pim* org.onosproject.cip* org.onosproject.acl* org.onosproject.vtn* @@ -54,4 +69,5 @@ org.onosproject.mfwd* org.onosproject.mcast* org.onosproject.flowanalyzer org.onosproject.grpc* -protobuf.* +org.onosproject.yangutils.parser.antlrgencode +org.onosproject.yangutils.* diff --git a/docs/external.xml b/docs/external.xml index a8fd9d58ce..2ee82d7401 100644 --- a/docs/external.xml +++ b/docs/external.xml @@ -48,10 +48,10 @@ maven-javadoc-plugin package - @external-excludes **/generated-sources/** + @external-excludes true ONOS Java API (1.5.0-SNAPSHOT) @@ -68,6 +68,10 @@ Utilities @utils + + App & Extensions + @external-apps + diff --git a/docs/internal-apps b/docs/internal-apps index ba72512739..e3138a22b1 100644 --- a/docs/internal-apps +++ b/docs/internal-apps @@ -5,6 +5,7 @@ org.onosproject.aaa org.onosproject.fwd org.onosproject.dhcp* org.onosproject.flowanalyzer +org.onosproject.cpman* org.onosproject.mobility org.onosproject.proxyarp org.onosproject.calendar @@ -28,11 +29,14 @@ org.onosproject.cord* org.onosproject.mcast* org.onosproject.mfwd* org.onosproject.mlb* -org.onosproject.igmp.impl +org.onosproject.igmp* +org.onosproject.pim* +org.onosproject.vpls* +org.onosproject.vrouter* org.onosproject.faultmanagement* org.onosproject.iptopology* org.onosproject.drivermatrix* org.onosproject.pathpainter* -org.onosproject.openstackswitching* +org.onosproject.openstack* org.onosproject.forwarder* org.onosproject.sfc* diff --git a/docs/internal-bgpls b/docs/internal-bgpls index f264c7dbd9..25bf23cca0 100644 --- a/docs/internal-bgpls +++ b/docs/internal-bgpls @@ -1,2 +1,3 @@ org.onosproject.bgp.controller* -org.onosproject.bgpio* +org.onosproject.bgp* +org.onosproject.provider.bgp* diff --git a/docs/internal-drivers b/docs/internal-drivers index fb2dea4451..90cf08dc6c 100644 --- a/docs/internal-drivers +++ b/docs/internal-drivers @@ -1,2 +1 @@ -org.onosproject.driver -org.onosproject.driver.* +org.onosproject.driver* diff --git a/docs/internal-excludes b/docs/internal-excludes index a24d184d8d..81e6329f2c 100644 --- a/docs/internal-excludes +++ b/docs/internal-excludes @@ -5,4 +5,5 @@ org.onlab.thirdparty org.onosproject.oecfg org.onosproject.maven org.onosproject.grpc* +org.onosproject.yangutils.* protobuf.* diff --git a/docs/internal-ospf b/docs/internal-ospf new file mode 100644 index 0000000000..7fec14e46e --- /dev/null +++ b/docs/internal-ospf @@ -0,0 +1 @@ +org.onosproject.ospf* diff --git a/docs/internal-pcep b/docs/internal-pcep index 8d10514469..b11c2a4bb3 100644 --- a/docs/internal-pcep +++ b/docs/internal-pcep @@ -1,2 +1,3 @@ org.onosproject.pcep* org.onosproject.pcepio* +org.onosproject.provider.pcep* diff --git a/docs/internal-providers b/docs/internal-providers index 832fb247ac..11871cd75b 100644 --- a/docs/internal-providers +++ b/docs/internal-providers @@ -1 +1,2 @@ org.onosproject.provider.* +org.onosproject.protocol.* diff --git a/docs/internal.xml b/docs/internal.xml index 03979774d1..aadbc4c3ed 100644 --- a/docs/internal.xml +++ b/docs/internal.xml @@ -74,39 +74,10 @@ @internal-stores - Incubator for Core Subsystems & - Distributed Stores + <title>Incubator for Core Subsystems & Distributed Stores @internal-incubator - - OpenFlow Providers & Controller - @internal-openflow - - - NetConf Providers - @internal-netconf - - - OVSDB Providers - @internal-ovsdb - - - PCEP Providers - @internal-pcep - - - BGP-LS Providers - @internal-bgpls - - - Other Providers - @internal-providers - - - Built-in Device Drivers - @internal-drivers - Utilities @utils @@ -124,6 +95,42 @@ @internal-test-apps + + OpenFlow Providers & Controller + @internal-openflow + + + NetConf Protocol & Providers + @internal-netconf + + + OVSDB Protocol & Providers + @internal-ovsdb + + + PCEP Protocol & Providers + @internal-pcep + + + BGP-LS Protocol & Providers + @internal-bgpls + + + OSPF Protocol & Providers + @internal-ospf + + + REST Protocol & Providers + @internal-restsb + + + Other Providers + @internal-providers + + + Device Drivers + @internal-drivers +