Author: vsiveton
Date: Thu Jul 31 04:50:01 2008
New Revision: 681346
URL: http://svn.apache.org/viewvc?rev=681346&view=rev
Log:
o added output conf doc
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/output-configuration.apt
(with props)
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/output-configuration.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/output-configuration.apt?rev=681346&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/output-configuration.apt
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/output-configuration.apt
Thu Jul 31 04:50:01 2008
@@ -0,0 +1,59 @@
+ ------
+ Using Alternative Output Directory
+ ------
+ Vincent Siveton
+ ------
+ 2008-07-29
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Using Alternative Output Directory
+
+ To run the Javadocs reports in an other output directory, you need to
configure Javadoc Plugin as follow:
+
++-----+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+
<reportOutputDirectory>${project.reporting.outputDirectory}/myoutput</reportOutputDirectory>
+ <destDir>myapidocs</destDir>
+ ...
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----+
+
+ Running <<<mvn javadoc:javadoc>>> will output the Javadoc in the
+ <$\{project.reporting.outputDirectory\}/myoutput/myapidocs> instead of the
default directory, i.e.
+ <$\{project.reporting.outputDirectory\}/apidocs>.
+
+ <<Note>>: Running <mvn site> will automatically use the
<$\{project.reporting.outputDirectory\}> directory and
+ in this case, <reportOutputDirectory> has no effect. Only, <testDestDir> and
<destDir> could be used.
Propchange:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/output-configuration.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/output-configuration.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml?rev=681346&r1=681345&r2=681346&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml Thu Jul 31
04:50:01 2008
@@ -38,6 +38,7 @@
<item name="Using Alternate Doclets"
href="/examples/alternate-doclet.html"/>
<item name="Using Alternate Javadoc Tool"
href="/examples/alternate-javadoc-tool.html"/>
<item name="Using Javadoc Resources"
href="/examples/javadoc-resources.html"/>
+ <item name="Using Alternative Output Directory"
href="/examples/output-configuration.html"/>
<item name="Configuring Stylesheets"
href="/examples/stylesheet-configuration.html"/>
<item name="Configuring Custom Tags"
href="/examples/tag-configuration.html"/>
<item name="Configuring Custom Taglets"
href="/examples/taglet-configuration.html"/>
