diff --git a/javadoc/plugin.jelly b/javadoc/plugin.jelly index f8aa46e4..462393ae 100644 --- a/javadoc/plugin.jelly +++ b/javadoc/plugin.jelly @@ -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}] - + + + + + + + + + diff --git a/javadoc/plugin.properties b/javadoc/plugin.properties index 15c8a0f3..3152746e 100644 --- a/javadoc/plugin.properties +++ b/javadoc/plugin.properties @@ -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 diff --git a/javadoc/project.xml b/javadoc/project.xml index b7d50480..8f5736bd 100644 --- a/javadoc/project.xml +++ b/javadoc/project.xml @@ -20,7 +20,7 @@ ../plugin-parent/project.xml maven-javadoc-plugin Maven Javadoc Plug-in - 1.7 + 1.8-SNAPSHOT Produce Javadocs and report http://maven.apache.org/reference/plugins/javadoc/ http://jira.codehaus.org/browse/MPJAVADOC diff --git a/javadoc/src/plugin-test/test09/.cvsignore b/javadoc/src/plugin-test/test09/.cvsignore new file mode 100644 index 00000000..1c60143a --- /dev/null +++ b/javadoc/src/plugin-test/test09/.cvsignore @@ -0,0 +1,5 @@ +gump.xml +*.log +targetdist +dist +target diff --git a/javadoc/src/plugin-test/test09/maven.xml b/javadoc/src/plugin-test/test09/maven.xml new file mode 100644 index 00000000..a7a14c56 --- /dev/null +++ b/javadoc/src/plugin-test/test09/maven.xml @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/project.properties b/javadoc/src/plugin-test/test09/project.properties new file mode 100644 index 00000000..8c229227 --- /dev/null +++ b/javadoc/src/plugin-test/test09/project.properties @@ -0,0 +1,2 @@ +maven.javadoc.footer = My Javadoc Footer +maven.javadoc.header = My Javadoc Header \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/project.xml b/javadoc/src/plugin-test/test09/project.xml new file mode 100644 index 00000000..abbfe8d1 --- /dev/null +++ b/javadoc/src/plugin-test/test09/project.xml @@ -0,0 +1,66 @@ + + + + + + 3 + test-maven-javadoc-plugin-09 + MPJAVADOC-54 + maven + 1.0 + + Apache Software Foundation + http://www.apache.org/ + http://maven.apache.org/images/apache-maven-project.png + + 2005 + org.apache + http://maven.apache.org/images/maven.jpg + Test MPJAVADOC-54 + Test MPJAVADOC-54 + http://maven.apache.org/reference/plugins/javadoc/index.html + /www/maven.apache.org/reference/plugins/javadoc/ + + scm:svn:http://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk/javadoc/ + http://svn.apache.org/viewcvs.cgi/maven/maven-1/plugins/trunk/javadoc/ + + + + dIon Gillard + dion + dion@multitask.com.au + Multitask Consulting + + Documentation + + + + Arnaud Heritier + aheritier + aheritier@apache.org + + Developer + + + + + + src/main + + \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy.java b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy.java new file mode 100644 index 00000000..3540d6cd --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy.java @@ -0,0 +1,8 @@ +package org.apache.maven; + +public class Dummy +{ + public String badChecky = "error"; + + public Dummy() {} +} diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy2.java b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy2.java new file mode 100644 index 00000000..a8f60c78 --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/Dummy2.java @@ -0,0 +1,8 @@ +package org.apache.maven; + +public class Dummy2 +{ + public String badChecky = "error"; + + public Dummy dummy = new Dummy(); +} diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven/doc-files/example.txt b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/doc-files/example.txt new file mode 100644 index 00000000..78264689 --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/doc-files/example.txt @@ -0,0 +1 @@ +This an example \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven/package.html b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/package.html new file mode 100644 index 00000000..545e7eb8 --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven/package.html @@ -0,0 +1,7 @@ + + + +Package documentation.
+example.txt in doc-files directory. + + \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy3.java b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy3.java new file mode 100644 index 00000000..cd88a1f3 --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy3.java @@ -0,0 +1,10 @@ +package org.apache.maven2; + +/** + * Test MPJAVADOC-28 : {@link org.apache.maven} + * + */ +public class Dummy3 +{ + public String badChecky = "error"; +} \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy4.java b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy4.java new file mode 100644 index 00000000..fb3cae97 --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/Dummy4.java @@ -0,0 +1,6 @@ +package org.apache.maven2; + +public class Dummy4 +{ + public String badChecky = "error"; +} \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/doc-files/example.txt b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/doc-files/example.txt new file mode 100644 index 00000000..78264689 --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/doc-files/example.txt @@ -0,0 +1 @@ +This an example \ No newline at end of file diff --git a/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/package.html b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/package.html new file mode 100644 index 00000000..545e7eb8 --- /dev/null +++ b/javadoc/src/plugin-test/test09/src/main/org/apache/maven2/package.html @@ -0,0 +1,7 @@ + + + +Package documentation.
+example.txt in doc-files directory. + + \ No newline at end of file diff --git a/javadoc/xdocs/changes.xml b/javadoc/xdocs/changes.xml index cfd8e077..6a001977 100644 --- a/javadoc/xdocs/changes.xml +++ b/javadoc/xdocs/changes.xml @@ -26,6 +26,9 @@ Arnaud Heritier + + Added maven.javadoc.header and maven.javadoc.footer properties. + Standard doclet parameters were passed to javadoc even if another doclet is used. Output encoding and charset are setted to ${maven.docs.outputencoding} diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index 44d05c19..66667c89 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -194,6 +194,24 @@ tag2.scope=all ${maven.docs.dest}/apidocs. + + maven.javadoc.footer + Yes + + 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. + + + + maven.javadoc.header + Yes + + 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. + + maven.javadoc.links Yes