Changed the name of that property to 'includeProjectDocumentation' as

its more descriptive.  The docs are always generated, this property is
just a little shortcut to have them not displayed in the navigation bar.

I've also updated the documentation to reflect this change.


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112834 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
kaz 2003-02-04 04:08:31 +00:00
parent 2e549c0f09
commit c940fa00ad
4 changed files with 17 additions and 4 deletions

View File

@ -266,8 +266,8 @@
<!-- Does the user want the maven-generated docs on their site? --> <!-- Does the user want the maven-generated docs on their site? -->
<j:set <j:set
var="generateProjectDocumentation" var="includeProjectDocumentation"
value="${maven.xdoc.generateProjectDocumentation}"/> value="${maven.xdoc.includeProjectDocumentation}"/>
<!-- Need the escaper to html output. --> <!-- Need the escaper to html output. -->
<j:useBean var="escape" class="org.apache.velocity.anakia.Escape"/> <j:useBean var="escape" class="org.apache.velocity.anakia.Escape"/>

View File

@ -10,7 +10,7 @@ maven.docs.outputencoding = ISO-8859-1
maven.gen.docs = ${maven.build.dir}/generated-xdocs maven.gen.docs = ${maven.build.dir}/generated-xdocs
maven.xdoc.developmentProcessUrl=http://jakarta.apache.org/turbine/maven/development-process.html maven.xdoc.developmentProcessUrl=http://jakarta.apache.org/turbine/maven/development-process.html
maven.xdoc.generateProjectDocumentation = yes maven.xdoc.includeProjectDocumentation = yes
# #
# DATE Preferences # DATE Preferences

View File

@ -147,7 +147,7 @@
! Check to see if the user wishes to include the ! Check to see if the user wishes to include the
! maven-generated docs on their site. ! maven-generated docs on their site.
!--> !-->
<j:if test="${generateProjectDocumentation.equals('yes')}"> <j:if test="${includeProjectDocumentation.equals('yes')}">
<div> <div>
<strong>Project Documentation</strong> <strong>Project Documentation</strong>
<div> <div>

View File

@ -411,6 +411,19 @@
Defaults to "en", ie english. Defaults to "en", ie english.
</td> </td>
</tr> </tr>
<tr>
<td>maven.xdoc.includeProjectDocumentation</td>
<td>Yes</td>
<td>
Specifies if Maven should display the maven generated
project documentation on the site's navigation bar. By
default, Maven includes numerous reports and information
regarding a project. Set this value to 'no' to prevent the
inclusion on the navigation bar. Users building a
documentation site only (non-project related) will find this
value useful.
</td>
</tr>
<tr> <tr>
<td>maven.xdoc.developmentProcessUrl</td> <td>maven.xdoc.developmentProcessUrl</td>
<td>Yes</td> <td>Yes</td>