aheritier 2004/07/07 16:01:13
Modified: javadoc plugin.jelly plugin.properties
javadoc/xdocs changes.xml properties.xml
Log:
PR: MPJAVADOC-30
Submitted by: Maarten Coene
Reviewed by: Arnaud Heritier
Use the property 'maven.javadoc.excludepackagenames' to exclude packages from
javadoc generation.
Revision Changes Path
1.49 +34 -29 maven-plugins/javadoc/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/plugin.jelly,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- plugin.jelly 7 Jul 2004 21:55:27 -0000 1.48
+++ plugin.jelly 7 Jul 2004 23:01:12 -0000 1.49
@@ -46,41 +46,42 @@
==================================
=== java plugin properties ===
==================================
-maven.compile.encoding = [${maven.compile.encoding}]
+maven.compile.encoding = [${maven.compile.encoding}]
==================================
=== javadoc plugin properties ===
==================================
-maven.javadoc.additionalparam = [${maven.javadoc.additionalparam}]
-maven.javadoc.author = [${maven.javadoc.author}]
-maven.javadoc.customtags = [${maven.javadoc.customtags}]
-maven.javadoc.debug = [${maven.javadoc.debug}]
-maven.javadoc.destdir = [${maven.javadoc.destdir}]
-maven.javadoc.doclet = [${maven.javadoc.doclet}]
-maven.javadoc.docletpath = [${maven.javadoc.docletpath}]
-maven.javadoc.links = [${maven.javadoc.links}]
-maven.javadoc.locale = [${maven.javadoc.locale}]
-maven.javadoc.maxmemory = [${maven.javadoc.maxmemory}]
-maven.javadoc.mode.online = [${maven.javadoc.mode.online}]
-maven.javadoc.offlineLinks = [${maven.javadoc.offlineLinks}]
-maven.javadoc.overview = [${maven.javadoc.overview}]
-maven.javadoc.package = [${maven.javadoc.package}]
-maven.javadoc.private = [${maven.javadoc.private}]
-maven.javadoc.public = [${maven.javadoc.public}]
-maven.javadoc.source = [${maven.javadoc.source}]
-maven.javadoc.stylesheet = [${maven.javadoc.stylesheet}]
-maven.javadoc.tagletpath = [${maven.javadoc.tagletpath}]
-maven.javadoc.taglets = [${maven.javadoc.taglets}]
-maven.javadoc.use = [${maven.javadoc.use}]
-maven.javadoc.useexternalfile = [${maven.javadoc.useexternalfile}]
-maven.javadoc.version = [${maven.javadoc.version}]
-maven.javadoc.windowtitle = [${maven.javadoc.windowtitle}]
+maven.javadoc.additionalparam = [${maven.javadoc.additionalparam}]
+maven.javadoc.author = [${maven.javadoc.author}]
+maven.javadoc.customtags = [${maven.javadoc.customtags}]
+maven.javadoc.debug = [${maven.javadoc.debug}]
+maven.javadoc.destdir = [${maven.javadoc.destdir}]
+maven.javadoc.doclet = [${maven.javadoc.doclet}]
+maven.javadoc.docletpath = [${maven.javadoc.docletpath}]
+maven.javadoc.excludepackagenames = [${maven.javadoc.excludepackagenames}]
+maven.javadoc.links = [${maven.javadoc.links}]
+maven.javadoc.locale = [${maven.javadoc.locale}]
+maven.javadoc.maxmemory = [${maven.javadoc.maxmemory}]
+maven.javadoc.mode.online = [${maven.javadoc.mode.online}]
+maven.javadoc.offlineLinks = [${maven.javadoc.offlineLinks}]
+maven.javadoc.overview = [${maven.javadoc.overview}]
+maven.javadoc.package = [${maven.javadoc.package}]
+maven.javadoc.private = [${maven.javadoc.private}]
+maven.javadoc.public = [${maven.javadoc.public}]
+maven.javadoc.source = [${maven.javadoc.source}]
+maven.javadoc.stylesheet = [${maven.javadoc.stylesheet}]
+maven.javadoc.tagletpath = [${maven.javadoc.tagletpath}]
+maven.javadoc.taglets = [${maven.javadoc.taglets}]
+maven.javadoc.use = [${maven.javadoc.use}]
+maven.javadoc.useexternalfile = [${maven.javadoc.useexternalfile}]
+maven.javadoc.version = [${maven.javadoc.version}]
+maven.javadoc.windowtitle = [${maven.javadoc.windowtitle}]
==================================
=== javadoc internal variables ===
==================================
-internal.javadoc.jar = [${internal.javadoc.jar}]
-internal.javadoc.needed = [${internal.javadoc.needed}]
-internal.javadoc.src.set = [${internal.javadoc.src.set}]
-internal.javadoc.working.dir = [${internal.javadoc.working.dir}]
+internal.javadoc.jar = [${internal.javadoc.jar}]
+internal.javadoc.needed = [${internal.javadoc.needed}]
+internal.javadoc.src.set = [${internal.javadoc.src.set}]
+internal.javadoc.working.dir = [${internal.javadoc.working.dir}]
</ant:echo>
</j:if>
<j:if test="not ${maven.javadoc.debug}">
@@ -253,6 +254,10 @@
<j:if test="${context.getVariable('maven.compile.encoding') != null}">
<ant:setProperty name="encoding" value="${maven.compile.encoding}" />
+ </j:if>
+
+ <j:if test="${context.getVariable('maven.javadoc.excludepackagenames') !=
null}">
+ <ant:setProperty name="excludepackagenames"
value="${maven.javadoc.excludepackagenames}" />
</j:if>
<!-- Process/Parse links -->
1.14 +16 -15 maven-plugins/javadoc/plugin.properties
Index: plugin.properties
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/plugin.properties,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- plugin.properties 28 Jun 2004 22:58:28 -0000 1.13
+++ plugin.properties 7 Jul 2004 23:01:12 -0000 1.14
@@ -21,32 +21,33 @@
# -------------------------------------------------------------------
#maven.javadoc.additionalparam
-maven.javadoc.author = true
+maven.javadoc.author = true
#maven.javadoc.customtags
-maven.javadoc.debug = false
-maven.javadoc.destdir = ${maven.docs.dest}/apidocs
+maven.javadoc.debug = false
+maven.javadoc.destdir = ${maven.docs.dest}/apidocs
# optional properties for specifying a custom doclet
-#maven.javadoc.doclet =
-#maven.javadoc.docletpath =
+#maven.javadoc.doclet =
+#maven.javadoc.docletpath =
-maven.javadoc.links =
+#maven.javadoc.excludepackagenames =
+maven.javadoc.links =
#specify an alternate locale
-#maven.javadoc.locale = en_US
+#maven.javadoc.locale = en_US
#maven.javadoc.maxmemory
#maven.javadoc.mode.online
#maven.javadoc.offlineLinks
#maven.javadoc.overview
-maven.javadoc.package = true
-maven.javadoc.private = false
-maven.javadoc.public = false
+maven.javadoc.package = true
+maven.javadoc.private = false
+maven.javadoc.public = false
#maven.javadoc.source
-maven.javadoc.stylesheet = ${plugin.resources}/stylesheet.css
+maven.javadoc.stylesheet = ${plugin.resources}/stylesheet.css
#maven.javadoc.tagletpath
#maven.javadoc.taglets
-maven.javadoc.use = true
-maven.javadoc.useexternalfile = yes
-maven.javadoc.version = true
-maven.javadoc.windowtitle = ${pom.name} ${pom.currentVersion} API
\ No newline at end of file
+maven.javadoc.use = true
+maven.javadoc.useexternalfile = yes
+maven.javadoc.version = true
+maven.javadoc.windowtitle = ${pom.name} ${pom.currentVersion} API
\ No newline at end of file
1.36 +1 -0 maven-plugins/javadoc/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/changes.xml,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- changes.xml 7 Jul 2004 21:55:27 -0000 1.35
+++ changes.xml 7 Jul 2004 23:01:13 -0000 1.36
@@ -25,6 +25,7 @@
<body>
<release version="1.5.1-SNAPSHOT" date="In CVS">
<action dev="aheritier" type="fix" issue="MPJAVADOC-31" due-to="Takayoshi
Kimura">Use the property 'maven.compile.encoding' to set the encoding used when
reading sources in javadoc task.</action>
+ <action dev="aheritier" type="add" issue="MPJAVADOC-30" due-to="Maarten
Coene">Use the property 'maven.javadoc.excludepackagenames' to exclude packages from
javadoc generation.</action>
<action dev="aheritier" type="fix" issue="MPJAVADOC-29">Packages list broken
on jdk 1.3 for multiple packages.</action>
<action dev="aheritier" type="fix" issue="MPJAVADOC-28">@link tag not working
with package names.</action>
<action dev="aheritier" type="add">Add the property maven.javadoc.debug to
print informations to debug the plugin.</action>
1.18 +7 -0 maven-plugins/javadoc/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/properties.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- properties.xml 7 Jul 2004 21:55:27 -0000 1.17
+++ properties.xml 7 Jul 2004 23:01:13 -0000 1.18
@@ -110,6 +110,13 @@
</td>
</tr>
<tr>
+ <td>maven.javadoc.excludepackagenames</td>
+ <td>Yes</td>
+ <td>
+ Comma separated list of packages to exclude from the javadoc.
+ </td>
+ </tr>
+ <tr>
<td>maven.javadoc.links</td>
<td>Yes</td>
<td>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
