CAS-1229: Provide support for better site generation of the project

Allow the maven 'site' to include javadocs in its set of reports. Add additional reports for taglist and dependency/plugins version report. Correct the javadoc links in the README file.
weixin007 · Nov 19, 2012 · 91de149 · 91de149
1 parent 45b3dee
commit 91de149
Show file tree

Hide file tree

Showing 24 changed files with 667 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,8 @@ Please [see the maven docs][skip] on how to disable the tests.
 ## Documentation
 - [CAS Protocol][protocol]
 - [CAS User Manual](https://wiki.jasig.org/display/CASUM/Home)
-- [Javadocs](http://jasig.github.com/cas/apidocs/index.html)
+- [Javadocs](https://oss.sonatype.org/content/repositories/releases/org/jasig/cas/) 
+Javadocs may also be created locally using the Maven command: `mvn clean site site:stage` and will then be available at the `target/staging` folder of the root project directory.
 - [Release Notes](https://issues.jasig.org/secure/ReleaseNote.jspa?projectId=10007)
 
 ## Addons

diff --git a/cas-management-webapp/src/site/site.xml b/cas-management-webapp/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-compatibility/src/site/site.xml b/cas-server-compatibility/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-core/src/site/site.xml b/cas-server-core/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-documentation/src/site/site.xml b/cas-server-documentation/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-extension-clearpass/src/site/site.xml b/cas-server-extension-clearpass/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-integration-ehcache/src/site/site.xml b/cas-server-integration-ehcache/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-integration-jboss/src/site/site.xml b/cas-server-integration-jboss/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-integration-memcached/src/site/site.xml b/cas-server-integration-memcached/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-integration-restlet/src/site/site.xml b/cas-server-integration-restlet/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-support-generic/src/site/site.xml b/cas-server-support-generic/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-support-jdbc/src/site/site.xml b/cas-server-support-jdbc/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-support-ldap/src/site/site.xml b/cas-server-support-ldap/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>
diff --git a/cas-server-support-legacy/src/site/site.xml b/cas-server-support-legacy/src/site/site.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to Jasig under one or more contributor license
+    agreements. See the NOTICE file distributed with this work
+    for additional information regarding copyright ownership.
+    Jasig licenses this file to you 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 the following location:
+
+      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.
+
+-->
+<project name="Jasig CAS ${project.version}">
+    <body>        
+		<menu ref="parent" />
+        <menu ref="reports" name="Reports" inherit="top" />
+		<menu ref="modules" name="Modules" inherit="top" />
+    </body>
+</project>