Splitting aggregate javadoc generation into a separate project and pom.xml file.

Thomas Vachuska
Commit abfe8d3bc4dd5ec5f497f367934c190f9ae6137d abfe8d3b 1 parent 9def047b
Showing 6 changed files with 148 additions and 58 deletions
docs/external.xml
docs/pom.xml
src/main/javadoc/doc-files/onos-subsystem.png → docs/src/main/javadoc/doc-files/onos-subsystem.png
src/main/javadoc/doc-files/onos-tiers.png → docs/src/main/javadoc/doc-files/onos-tiers.png
src/main/javadoc/overview.html → docs/src/main/javadoc/overview.html
pom.xml
--- a/docs/external.xml 0 → 100644
View file @abfe8d3
+++ b/docs/external.xml 0 → 100644
View file @abfe8d3
+ <?xml version="1.0" encoding="UTF-8"?>
+ <project xmlns="http://maven.apache.org/POM/4.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+     <modelVersion>4.0.0</modelVersion>
+ 
+     <prerequisites>
+         <maven>3.0.0</maven>
+     </prerequisites>
+ 
+     <parent>
+         <groupId>org.onlab.onos</groupId>
+         <artifactId>onos</artifactId>
+         <version>1.0.0-SNAPSHOT</version>
+         <relativePath>../pom.xml</relativePath>
+     </parent>
+ 
+     <artifactId>onos-docs-external</artifactId>
+     <packaging>pom</packaging>
+ 
+     <description>ONOS Java API documentation</description>
+ 
+     <modules>
+         <module>..</module>
+     </modules>
+ 
+     <url>http://onlab.us/</url>
+ 
+     <build>
+         <plugins>
+             <plugin>
+                 <groupId>org.apache.maven.plugins</groupId>
+                 <artifactId>maven-javadoc-plugin</artifactId>
+                 <version>2.10.1</version>
+                 <configuration>
+                     <show>package</show>
+                     <excludePackageNames>org.onlab.thirdparty:*.impl:*.impl.*:org.onlab.onos.provider.*:org.onlab.onos.gui:org.onlab.onos.rest:org.onlab.onos.cli*:org.onlab.onos.tvue:org.onlab.onos.foo:org.onlab.onos.mobility:org.onlab.onos.proxyarp:org.onlab.onos.fwd:org.onlab.onos.ifwd:org.onlab.onos.optical:org.onlab.onos.config:org.onlab.onos.calendar:org.onlab.onos.sdnip*:org.onlab.onos.metrics</excludePackageNames>
+                     <docfilessubdirs>true</docfilessubdirs>
+                     <doctitle>ONOS Java API</doctitle>
+                     <groups>
+                         <group>
+                             <title>Network Model &amp; Services</title>
+                             <packages>
+                                 org.onlab.onos:org.onlab.onos.*
+                             </packages>
+                         </group>
+                         <group>
+                             <title>Utilities</title>
+                             <packages>
+                                 org.onlab.*
+                             </packages>
+                         </group>
+                     </groups>
+                 </configuration>
+             </plugin>
+         </plugins>
+     </build>
+ 
+ </project>
--- a/docs/pom.xml 0 → 100644
View file @abfe8d3
+++ b/docs/pom.xml 0 → 100644
View file @abfe8d3
+ <?xml version="1.0" encoding="UTF-8"?>
+ <project xmlns="http://maven.apache.org/POM/4.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+     <modelVersion>4.0.0</modelVersion>
+ 
+     <prerequisites>
+         <maven>3.0.0</maven>
+     </prerequisites>
+ 
+     <parent>
+         <groupId>org.onlab.onos</groupId>
+         <artifactId>onos</artifactId>
+         <version>1.0.0-SNAPSHOT</version>
+         <relativePath>../pom.xml</relativePath>
+     </parent>
+ 
+     <artifactId>onos-docs</artifactId>
+     <packaging>pom</packaging>
+ 
+     <description>ONOS Java API documentation</description>
+ 
+     <modules>
+         <module>..</module>
+     </modules>
+ 
+     <url>http://onlab.us/</url>
+ 
+     <build>
+         <plugins>
+             <plugin>
+                 <groupId>org.apache.maven.plugins</groupId>
+                 <artifactId>maven-javadoc-plugin</artifactId>
+                 <version>2.10.1</version>
+                 <configuration>
+                     <show>package</show>
+                     <docfilessubdirs>true</docfilessubdirs>
+                     <doctitle>ONOS Java API</doctitle>
+                     <groups>
+                         <group>
+                             <title>Network Model &amp; Services</title>
+                             <packages>
+                                 org.onlab.onos:org.onlab.onos.*
+                             </packages>
+                         </group>
+                         <group>
+                             <title>Core Subsystems</title>
+                             <packages>
+                                 org.onlab.onos.impl:org.onlab.onos.cluster.impl:org.onlab.onos.net.device.impl:org.onlab.onos.net.link.impl:org.onlab.onos.net.host.impl:org.onlab.onos.net.topology.impl:org.onlab.onos.net.packet.impl:org.onlab.onos.net.flow.impl:org.onlab.onos.store.trivial.*:org.onlab.onos.net.*.impl:org.onlab.onos.event.impl:org.onlab.onos.store.*:org.onlab.onos.net.intent.impl:org.onlab.onos.net.proxyarp.impl:org.onlab.onos.mastership.impl:org.onlab.onos.json:org.onlab.onos.json.*:org.onlab.onos.provider.host.impl:org.onlab.onos.provider.lldp.impl:org.onlab.onos.net.statistic.impl
+                             </packages>
+                         </group>
+                         <group>
+                             <title>OpenFlow Providers &amp; Controller
+                             </title>
+                             <packages>
+                                 org.onlab.onos.provider.of.*:org.onlab.onos.openflow.*
+                             </packages>
+                         </group>
+                         <group>
+                             <title>Utilities</title>
+                             <packages>
+                                 org.onlab.*
+                             </packages>
+                         </group>
+                         <group>
+                             <title>GUI, REST &amp; Command-Line</title>
+                             <packages>
+                                 org.onlab.onos.gui:org.onlab.onos.rest:org.onlab.onos.cli:org.onlab.onos.gui.*:org.onlab.onos.rest.*:org.onlab.onos.cli.*
+                             </packages>
+                         </group>
+                         <group>
+                             <title>Sample Applications</title>
+                             <packages>
+                                 org.onlab.onos.tvue:org.onlab.onos.fwd:org.onlab.onos.ifwd:org.onlab.onos.mobility:org.onlab.onos.proxyarp:org.onlab.onos.foo:org.onlab.onos.calendar:org.onlab.onos.sdnip:org.onlab.onos.sdnip.*:org.onlab.onos.optical:org.onlab.onos.optical.*:org.onlab.onos.metrics.*:org.onlab.onos.config
+                             </packages>
+                         </group>
+                     </groups>
+                     <excludePackageNames>org.onlab.thirdparty
+                     </excludePackageNames>
+                 </configuration>
+             </plugin>
+         </plugins>
+     </build>
+ 
+ </project>
--- a/src/main/javadoc/doc-files/onos-subsystem.png → docs/src/main/javadoc/doc-files/onos-subsystem.png
View file @abfe8d3
+++ b/src/main/javadoc/doc-files/onos-subsystem.png → docs/src/main/javadoc/doc-files/onos-subsystem.png
View file @abfe8d3
--- a/src/main/javadoc/doc-files/onos-tiers.png → docs/src/main/javadoc/doc-files/onos-tiers.png
View file @abfe8d3
+++ b/src/main/javadoc/doc-files/onos-tiers.png → docs/src/main/javadoc/doc-files/onos-tiers.png
View file @abfe8d3
--- a/src/main/javadoc/overview.html → docs/src/main/javadoc/overview.html
View file @abfe8d3
+++ b/src/main/javadoc/overview.html → docs/src/main/javadoc/overview.html
View file @abfe8d3
--- a/pom.xml
View file @abfe8d3
+++ b/pom.xml
View file @abfe8d3
@@ -4,6 +4,10 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
+     <prerequisites>
+         <maven>3.0.0</maven>
+     </prerequisites>
+ 
     <groupId>org.onlab.onos</groupId>
     <artifactId>onos</artifactId>
     <packaging>pom</packaging>
@@ -28,7 +32,6 @@
 
     <licenses>
         <license>
-             <!-- TODO: Is this really our license scheme? -->
             <name>Apache License, Version 2.0</name>
             <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
         </license>
@@ -528,59 +531,6 @@
                     </execution>
                 </executions>
             </plugin>
- 
-             <plugin>
-                 <groupId>org.apache.maven.plugins</groupId>
-                 <artifactId>maven-javadoc-plugin</artifactId>
-                 <version>2.10.1</version>
-                 <configuration>
-                     <show>package</show>
-                     <docfilessubdirs>true</docfilessubdirs>
-                     <doctitle>ONOS Java API</doctitle>
-                     <groups>
-                         <group>
-                             <title>Network Model &amp; Services</title>
-                             <packages>
-                                 org.onlab.onos:org.onlab.onos.*
-                             </packages>
-                         </group>
-                         <group>
-                             <title>Core Subsystems</title>
-                             <packages>
-                                 org.onlab.onos.impl:org.onlab.onos.cluster.impl:org.onlab.onos.net.device.impl:org.onlab.onos.net.link.impl:org.onlab.onos.net.host.impl:org.onlab.onos.net.topology.impl:org.onlab.onos.net.packet.impl:org.onlab.onos.net.flow.impl:org.onlab.onos.store.trivial.*:org.onlab.onos.net.*.impl:org.onlab.onos.event.impl:org.onlab.onos.store.*:org.onlab.onos.net.intent.impl:org.onlab.onos.net.proxyarp.impl:org.onlab.onos.mastership.impl:org.onlab.onos.json:org.onlab.onos.json.*:org.onlab.onos.provider.host.impl:org.onlab.onos.provider.lldp.impl:org.onlab.onos.net.statistic.impl
-                             </packages>
-                         </group>
-                         <group>
-                             <title>OpenFlow Providers &amp; Controller
-                             </title>
-                             <packages>
-                                 org.onlab.onos.provider.of.*:org.onlab.onos.openflow.*
-                             </packages>
-                         </group>
-                         <group>
-                             <title>Utilities</title>
-                             <packages>
-                                 org.onlab.*
-                             </packages>
-                         </group>
-                         <group>
-                             <title>GUI, REST &amp; Command-Line</title>
-                             <packages>
-                                 org.onlab.onos.gui:org.onlab.onos.rest:org.onlab.onos.cli:org.onlab.onos.gui.*:org.onlab.onos.rest.*:org.onlab.onos.cli.*
-                             </packages>
-                         </group>
-                         <group>
-                             <title>Sample Applications</title>
-                             <packages>
-                                 org.onlab.onos.tvue:org.onlab.onos.fwd:org.onlab.onos.ifwd:org.onlab.onos.mobility:org.onlab.onos.proxyarp:org.onlab.onos.foo:org.onlab.onos.calendar:org.onlab.onos.sdnip:org.onlab.onos.sdnip.*:org.onlab.onos.optical:org.onlab.onos.optical.*:org.onlab.onos.metrics.*
-                             </packages>
-                         </group>
-                     </groups>
-                     <excludePackageNames>org.onlab.thirdparty
-                     </excludePackageNames>
-                 </configuration>
-             </plugin>
- 
         </plugins>
     </build>
 
@@ -607,10 +557,6 @@
                     </rulesets>
                 </configuration>
             </plugin>
- 
         </plugins>
     </reporting>
-     <prerequisites>
-         <maven>3.0.0</maven>
-     </prerequisites>
 </project>