PR: MPJAVADOC-30

Submitted by:	Maarten Coene
Reviewed by:	Arnaud Heritier
Use the property 'maven.javadoc.excludepackagenames' to exclude packages from javadoc generation.


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

javadoc/plugin.jelly

@@ -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}">
@@ -254,6 +255,10 @@ internal.javadoc.working.dir    = [${internal.javadoc.working.dir}]
         <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 -->
         <!-- This code allows to specify a packagelistLoc even when in online mode -->

javadoc/plugin.properties

@@ -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
+maven.javadoc.use                   = true
+maven.javadoc.useexternalfile       = yes
+maven.javadoc.version               = true
+maven.javadoc.windowtitle           = ${pom.name} ${pom.currentVersion} API

javadoc/xdocs/changes.xml

@@ -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>

javadoc/xdocs/properties.xml

@@ -109,6 +109,13 @@ tag2.scope=all
             ant javadoc task</a> documentation for more detail.
           </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>