Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@160470 13f79535-47bb-0310-9956-ffa450edef68

Browse Source
This commit is contained in:
aheritier
2005-04-07 21:04:28 +00:00
parent 896ed8bc9e
commit 6c50a819b4
17 changed files with 194 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
javadoc/plugin.jelly
View File

@@ -82,6 +82,8 @@ maven.javadoc.author = [${maven.javadoc.author}]
maven.javadoc.bottom = [${maven.javadoc.bottom}]
maven.javadoc.customtags = [${maven.javadoc.customtags}]
maven.javadoc.destdir = [${maven.javadoc.destdir}]
maven.javadoc.footer = [${maven.javadoc.footer}]
maven.javadoc.header = [${maven.javadoc.header}]
maven.javadoc.links = [${maven.javadoc.links}]
maven.javadoc.offlineLinks = [${maven.javadoc.offlineLinks}]
maven.javadoc.mode.online = [${maven.javadoc.mode.online}]
@@ -409,7 +411,15 @@ internal_javadoc_working_dir = [${internal_javadoc_working_dir}]
<j:if test="${context.getVariable('maven.javadoc.bottom') != null and !context.getVariable('maven.javadoc.bottom').equals('')}">
<ant:setProperty name="bottom" value="${maven.javadoc.bottom}" />
</j:if>
<j:if test="${context.getVariable('maven.javadoc.footer') != null and !context.getVariable('maven.javadoc.footer').equals('')}">
<ant:setProperty name="footer" value="${maven.javadoc.footer}" />
</j:if>
<j:if test="${context.getVariable('maven.javadoc.header') != null and !context.getVariable('maven.javadoc.header').equals('')}">
<ant:setProperty name="header" value="${maven.javadoc.header}" />
</j:if>
<!-- Process/Parse links -->
<!-- This code allows to specify a packagelistLoc even when in online mode -->
<j:forEach var="link" items="${links}">

2
javadoc/plugin.properties
View File

@@ -32,6 +32,8 @@ maven.javadoc.destdir = ${maven.docs.dest}/apidocs
#maven.javadoc.docletpath =
#maven.javadoc.excludepackagenames =
#maven.javadoc.footer =
#maven.javadoc.header =
maven.javadoc.links =
#specify an alternate locale

2
javadoc/project.xml
View File

@@ -20,7 +20,7 @@
<extend>../plugin-parent/project.xml</extend>
<artifactId>maven-javadoc-plugin</artifactId>
<name>Maven Javadoc Plug-in</name>
<currentVersion>1.7</currentVersion>
<currentVersion>1.8-SNAPSHOT</currentVersion>
<shortDescription>Produce Javadocs and report</shortDescription>
<url>http://maven.apache.org/reference/plugins/javadoc/</url>
<issueTrackingUrl>http://jira.codehaus.org/browse/MPJAVADOC</issueTrackingUrl>

5
javadoc/src/plugin-test/test09/.cvsignore Normal file
View File

@@ -0,0 +1,5 @@
gump.xml
*.log
targetdist
dist
target

38
javadoc/src/plugin-test/test09/maven.xml Normal file
View File

@@ -0,0 +1,38 @@
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* 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.
*/
-->
<project xmlns:util="jelly:util"
xmlns:maven="jelly:maven"
xmlns:j="jelly:core"
xmlns:assert="assert"
xmlns:ant="jelly:ant">
<goal name="testPlugin">
<delete dir="${maven.build.dir}" failonerror="false"/>
<delete file="${maven.build.dir}/${maven.final.name}_javadoc.jar" failonerror="false"/>
<attainGoal name="javadoc"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven/Dummy.html" match="My Javadoc Header"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven/Dummy2.html" match="My Javadoc Header"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven2/Dummy3.html" match="My Javadoc Header"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven2/Dummy4.html" match="My Javadoc Header"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven/Dummy.html" match="My Javadoc Footer"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven/Dummy2.html" match="My Javadoc Footer"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven2/Dummy3.html" match="My Javadoc Footer"/>
<assert:assertFileContains file="${maven.javadoc.destdir}/org/apache/maven2/Dummy4.html" match="My Javadoc Footer"/>
</goal>
</project>

2
javadoc/src/plugin-test/test09/project.properties Normal file
View File

@@ -0,0 +1,2 @@
maven.javadoc.footer = My Javadoc Footer
maven.javadoc.header = My Javadoc Header

66
javadoc/src/plugin-test/test09/project.xml Normal file
View File

@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* 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.
*/
-->
<project>
<pomVersion>3</pomVersion>
<id>test-maven-javadoc-plugin-09</id>
<name>MPJAVADOC-54</name>
<groupId>maven</groupId>
<currentVersion>1.0</currentVersion>
<organization>
<name>Apache Software Foundation</name>
<url>http://www.apache.org/</url>
<logo>http://maven.apache.org/images/apache-maven-project.png</logo>
</organization>
<inceptionYear>2005</inceptionYear>
<package>org.apache</package>
<logo>http://maven.apache.org/images/maven.jpg</logo>
<description>Test MPJAVADOC-54</description>
<shortDescription>Test MPJAVADOC-54</shortDescription>
<url>http://maven.apache.org/reference/plugins/javadoc/index.html</url>
<siteDirectory>/www/maven.apache.org/reference/plugins/javadoc/</siteDirectory>
<repository>
<connection>scm:svn:http://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk/javadoc/</connection>
<url>http://svn.apache.org/viewcvs.cgi/maven/maven-1/plugins/trunk/javadoc/</url>
</repository>
<developers>
<developer>
<name>dIon Gillard</name>
<id>dion</id>
<email>dion@multitask.com.au</email>
<organization>Multitask Consulting</organization>
<roles>
<role>Documentation</role>
</roles>
</developer>
<developer>
<name>Arnaud Heritier</name>
<id>aheritier</id>
<email>aheritier@apache.org</email>
<roles>
<role>Developer</role>
</roles>
</developer>
</developers>
<build>
<sourceDirectory>src/main</sourceDirectory>
</build>
</project>

8
javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy.java Normal file
View File

@@ -0,0 +1,8 @@
package org.apache.maven;
public class Dummy
{
public String badChecky = "error";
public Dummy() {}
}

8
javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy2.java Normal file
View File

@@ -0,0 +1,8 @@
package org.apache.maven;
public class Dummy2
{
public String badChecky = "error";
public Dummy dummy = new Dummy();
}

1
javadoc/src/plugin-test/test09/src/main/org/apache/maven/doc-files/example.txt Normal file
View File

@@ -0,0 +1 @@
This an example

7
javadoc/src/plugin-test/test09/src/main/org/apache/maven/package.html Normal file
View File

@@ -0,0 +1,7 @@
<html>
<head></head>
<body>
Package documentation. <br/>
<a href="doc-files/example.txt">example.txt</a> in doc-files directory.
</body>
</html>

10
javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy3.java Normal file
View File

@@ -0,0 +1,10 @@
package org.apache.maven2;
/**
* Test MPJAVADOC-28 : {@link org.apache.maven}
*
*/
public class Dummy3
{
public String badChecky = "error";
}

6
javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy4.java Normal file
View File

@@ -0,0 +1,6 @@
package org.apache.maven2;
public class Dummy4
{
public String badChecky = "error";
}

1
javadoc/src/plugin-test/test09/src/main/org/apache/maven2/doc-files/example.txt Normal file
View File

@@ -0,0 +1 @@
This an example

7
javadoc/src/plugin-test/test09/src/main/org/apache/maven2/package.html Normal file
View File

@@ -0,0 +1,7 @@
<html>
<head></head>
<body>
Package documentation. <br/>
<a href="doc-files/example.txt">example.txt</a> in doc-files directory.
</body>
</html>

3
javadoc/xdocs/changes.xml
View File

@@ -26,6 +26,9 @@
<author email="aheritier@apache.org">Arnaud Heritier</author>
</properties>
<body>
<release version="1.8" date="In SVN">
<action dev="aheritier" type="add" issue="MPJAVADOC-54" due-to="Dag Sverre Seljebotn">Added maven.javadoc.header and maven.javadoc.footer properties.</action>
</release>
<release version="1.7" date="2004-09-26">
<action dev="aheritier" type="fix" issue="MPJAVADOC-46">Standard doclet parameters were passed to javadoc even if another doclet is used.</action>
<action dev="aheritier" type="add" issue="MPJAVADOC-45">Output encoding and charset are setted to ${maven.docs.outputencoding}</action>

18
javadoc/xdocs/properties.xml
View File

@@ -194,6 +194,24 @@ tag2.scope=all
<code>${maven.docs.dest}/apidocs</code>.
</td>
</tr>
<tr>
<td>maven.javadoc.footer</td>
<td>Yes</td>
<td>
Specifies the text or html fragment to be placed to the right of the bottom navigation bar
on all pages. The default is to not have a footer. If the footer is not set,
but the header is, then Javadoc will user the header in both places.
</td>
</tr>
<tr>
<td>maven.javadoc.header</td>
<td>Yes</td>
<td>
Specifies the text or html fragment to be placed at the top of the navigation frame in the upper-left corner,
and to the right of the top navigation bar on all pages. The default is to not have a header.
Javadoc will be use this as the footer as well if the footer is not set explicitly.
</td>
</tr>
<tr>
<td>maven.javadoc.links</td>
<td>Yes</td>