blob: 0cee77df1d02277006c93a5f60b4a58c051ed3e3 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>tycho-document-bundle:javadoc</title>
</properties>
<body>
<section name="tycho-document-bundle:javadoc">
<p><strong>Full name</strong>:</p>
<p>org.eclipse.tycho.extras:tycho-document-bundle-plugin:1.5.1-SNAPSHOT:javadoc</p>
<p><strong>Description</strong>:</p>
<div>Create the javadoc based API reference for this bundle <br />
This mojo creates the javadoc documentation by calling the javadoc
application from the command line. In addition it creates a ready
to include toc-xml file for the Eclipse Help system. <br />
The sources for creating the javadoc are generated automatically
based on the dependency that this project has. As dependency you
can specify any other maven project, for example the feature
project that references you other bundles. Included features will
be added to the list.</div>
<p><strong>Attributes</strong>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Requires dependency resolution of artifacts in scope: <code>compile+runtime</code>.</li>
<li>Since version: <code>0.20.0</code>.</li>
<li>Binds by default to the <a href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>process-classes</code>.</li>
</ul>
<subsection name="Required Parameters">
<table border="0">
<tr>
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr>
<td><code><a href="#buildDirectory">&lt;buildDirectory&gt;</a></code></td>
<td><code>File</code></td>
<td><code>0.20.0</code></td>
<td>The build directory where temporary build files will be placed<br/><strong>User property is</strong>: <code>project.build.directory</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#outputDirectory">&lt;outputDirectory&gt;</a></code></td>
<td><code>File</code></td>
<td><code>0.20.0</code></td>
<td>The directory where the javadoc content will be generated<br/><strong>Default value is</strong>: <code>${project.build.directory}/reference/api</code>.<br/><strong>User property is</strong>: <code>outputDirectory</code>.<br/></td>
</tr>
</table>
</subsection>
<subsection name="Optional Parameters">
<table border="0">
<tr>
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr>
<td><code><a href="#cleanFirst">&lt;cleanFirst&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>0.20.0</code></td>
<td>An option to clean out the whole outputDirectory first.<br/><strong>Default value is</strong>: <code>true</code>.<br/><strong>User property is</strong>: <code>cleanFirst</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#javadocOptions">&lt;javadocOptions&gt;</a></code></td>
<td><code>JavadocOptions</code></td>
<td><code>0.20.0</code></td>
<td>Options for calling the javadoc application. Possible options are
(all options are optional):
<ul>
<li><tt>ignoreError</tt>, specifies if errors calling javadoc
should be ignored</li>
<li><tt>doclet</tt>, used as javadoc <tt>-doclet</tt>
parameter</li>
<li><tt>docletArtifacts</tt>, dependencies will be resovled and
added as <tt>-docletpath</tt> parameter</li>
<li><tt>encoding</tt>, used as javadoc <tt>-encoding</tt> parameter
(default: <tt>${project.build.sourceEncoding}</tt></li>
<li><tt>additionalArguments</tt>, a list of additional arguments
passed to javadoc</li>
<li><tt>includes</tt>/<tt>excludes</tt>, the list of names of
packages to be included in or excluded from JavaDoc processing; use
'<tt>*</tt>' character as wildcard</li>
</ul>
Example configuration:
<pre>
&lt;configuration&gt;
&lt;javadocOptions&gt;
&lt;ignoreError&gt;false&lt;/ignoreError&gt;
&lt;encoding&gt;UTF-8&lt;/encoding&gt;
&lt;doclet&gt;foo.bar.MyDoclet&lt;/doclet&gt;
&lt;docletArtifacts&gt;
&lt;docletArtifact&gt;
&lt;groupId&gt;foo.bar&lt;/groupId&gt;
&lt;artifactId&gt;foo.bar.mydocletartifact&lt;/artifactId&gt;
&lt;version&gt;1.0&lt;/version&gt;
&lt;/docletArtifact&gt;
&lt;/docletArtifacts&gt;
&lt;includes&gt;
&lt;include&gt;com.example.*&lt;/include&gt;
&lt;/includes&gt;
&lt;excludes&gt;
&lt;exclude&gt;com.example.internal.*&lt;/exclude&gt;
&lt;/excludes&gt;
&lt;additionalArguments&gt;
&lt;additionalArgument&gt;-windowtitle "The Window Title"&lt;/additionalArgument&gt;
&lt;additionalArgument&gt;-nosince&lt;/additionalArgument&gt;
&lt;/additionalArguments&gt;
&lt;/javadocOptions&gt;
&lt;/configuration&gt;
</pre><br/><strong>User property is</strong>: <code>javadocOptions</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#scopes">&lt;scopes&gt;</a></code></td>
<td><code>Set</code></td>
<td><code>0.20.0</code></td>
<td>The scopes that the dependencies must have in order to be included<br/><strong>Default value is</strong>: <code>compile,provided</code>.<br/><strong>User property is</strong>: <code>scopes</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#skipTocGen">&lt;skipTocGen&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>0.20.0</code></td>
<td>Set this property to true to skip the generation of the Eclipse TOC
files.<br/><strong>Default value is</strong>: <code>false</code>.<br/><strong>User property is</strong>: <code>skipTocGen</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#sourceTypes">&lt;sourceTypes&gt;</a></code></td>
<td><code>Set</code></td>
<td><code>0.20.0</code></td>
<td>Maven module types that will be used to include the source<br/><strong>Default value is</strong>: <code>eclipse-plugin</code>.<br/><strong>User property is</strong>: <code>sourceTypes</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#tocFile">&lt;tocFile&gt;</a></code></td>
<td><code>File</code></td>
<td><code>0.20.0</code></td>
<td>The output location of the toc file.<br />
This file will be overwritten.<br/><strong>Default value is</strong>: <code>${project.build.directory}/tocjavadoc.xml</code>.<br/><strong>User property is</strong>: <code>tocFile</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#tocOptions">&lt;tocOptions&gt;</a></code></td>
<td><code>TocOptions</code></td>
<td><code>0.20.0</code></td>
<td>Options for creating the toc files.
<ul>
<li><tt>mainLabel</tt>, specifies the main label of the toc file
(default: "API Reference")</li>
<li><tt>mainFilename</tt>, specifies the filename of the TOC file
(default: "overview-summary.html")</li>
</ul>
Example configuration:
<pre>
&lt;configuration&gt;
&lt;tocOptions&gt;
&lt;mainLabel&gt;My own label&lt;/mainLabel&gt;
&lt;mainFilename&gt;myOverviewSummary.html&lt;/mainFilename&gt;
&lt;/tocOptions&gt;
&lt;/configuration&gt;
</pre><br/><strong>User property is</strong>: <code>tocOptions</code>.<br/></td>
</tr>
</table>
</subsection>
<subsection name="Parameter Details">
<h4><strong><a name="buildDirectory">&lt;buildDirectory&gt;</a></strong></h4>
<div>The build directory where temporary build files will be placed</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>User Property</strong>: <code>project.build.directory</code></li>
</ul><hr/><h4><strong><a name="cleanFirst">&lt;cleanFirst&gt;</a></strong></h4>
<div>An option to clean out the whole outputDirectory first.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>cleanFirst</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul><hr/><h4><strong><a name="javadocOptions">&lt;javadocOptions&gt;</a></strong></h4>
<div>Options for calling the javadoc application. Possible options are
(all options are optional):
<ul>
<li><tt>ignoreError</tt>, specifies if errors calling javadoc
should be ignored</li>
<li><tt>doclet</tt>, used as javadoc <tt>-doclet</tt>
parameter</li>
<li><tt>docletArtifacts</tt>, dependencies will be resovled and
added as <tt>-docletpath</tt> parameter</li>
<li><tt>encoding</tt>, used as javadoc <tt>-encoding</tt> parameter
(default: <tt>${project.build.sourceEncoding}</tt></li>
<li><tt>additionalArguments</tt>, a list of additional arguments
passed to javadoc</li>
<li><tt>includes</tt>/<tt>excludes</tt>, the list of names of
packages to be included in or excluded from JavaDoc processing; use
'<tt>*</tt>' character as wildcard</li>
</ul>
Example configuration:
<pre>
&lt;configuration&gt;
&lt;javadocOptions&gt;
&lt;ignoreError&gt;false&lt;/ignoreError&gt;
&lt;encoding&gt;UTF-8&lt;/encoding&gt;
&lt;doclet&gt;foo.bar.MyDoclet&lt;/doclet&gt;
&lt;docletArtifacts&gt;
&lt;docletArtifact&gt;
&lt;groupId&gt;foo.bar&lt;/groupId&gt;
&lt;artifactId&gt;foo.bar.mydocletartifact&lt;/artifactId&gt;
&lt;version&gt;1.0&lt;/version&gt;
&lt;/docletArtifact&gt;
&lt;/docletArtifacts&gt;
&lt;includes&gt;
&lt;include&gt;com.example.*&lt;/include&gt;
&lt;/includes&gt;
&lt;excludes&gt;
&lt;exclude&gt;com.example.internal.*&lt;/exclude&gt;
&lt;/excludes&gt;
&lt;additionalArguments&gt;
&lt;additionalArgument&gt;-windowtitle "The Window Title"&lt;/additionalArgument&gt;
&lt;additionalArgument&gt;-nosince&lt;/additionalArgument&gt;
&lt;/additionalArguments&gt;
&lt;/javadocOptions&gt;
&lt;/configuration&gt;
</pre></div>
<ul>
<li><strong>Type</strong>: <code>org.eclipse.tycho.extras.docbundle.JavadocOptions</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>javadocOptions</code></li>
</ul><hr/><h4><strong><a name="outputDirectory">&lt;outputDirectory&gt;</a></strong></h4>
<div>The directory where the javadoc content will be generated</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>User Property</strong>: <code>outputDirectory</code></li>
<li><strong>Default</strong>: <code>${project.build.directory}/reference/api</code></li>
</ul><hr/><h4><strong><a name="scopes">&lt;scopes&gt;</a></strong></h4>
<div>The scopes that the dependencies must have in order to be included</div>
<ul>
<li><strong>Type</strong>: <code>java.util.Set</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>scopes</code></li>
<li><strong>Default</strong>: <code>compile,provided</code></li>
</ul><hr/><h4><strong><a name="skipTocGen">&lt;skipTocGen&gt;</a></strong></h4>
<div>Set this property to true to skip the generation of the Eclipse TOC
files.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>skipTocGen</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul><hr/><h4><strong><a name="sourceTypes">&lt;sourceTypes&gt;</a></strong></h4>
<div>Maven module types that will be used to include the source</div>
<ul>
<li><strong>Type</strong>: <code>java.util.Set</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>sourceTypes</code></li>
<li><strong>Default</strong>: <code>eclipse-plugin</code></li>
</ul><hr/><h4><strong><a name="tocFile">&lt;tocFile&gt;</a></strong></h4>
<div>The output location of the toc file.<br />
This file will be overwritten.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>tocFile</code></li>
<li><strong>Default</strong>: <code>${project.build.directory}/tocjavadoc.xml</code></li>
</ul><hr/><h4><strong><a name="tocOptions">&lt;tocOptions&gt;</a></strong></h4>
<div>Options for creating the toc files.
<ul>
<li><tt>mainLabel</tt>, specifies the main label of the toc file
(default: "API Reference")</li>
<li><tt>mainFilename</tt>, specifies the filename of the TOC file
(default: "overview-summary.html")</li>
</ul>
Example configuration:
<pre>
&lt;configuration&gt;
&lt;tocOptions&gt;
&lt;mainLabel&gt;My own label&lt;/mainLabel&gt;
&lt;mainFilename&gt;myOverviewSummary.html&lt;/mainFilename&gt;
&lt;/tocOptions&gt;
&lt;/configuration&gt;
</pre></div>
<ul>
<li><strong>Type</strong>: <code>org.eclipse.tycho.extras.docbundle.TocOptions</code></li>
<li><strong>Since</strong>: <code>0.20.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>tocOptions</code></li>
</ul>
</subsection>
</section>
</body>
</document>