| <?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"><buildDirectory></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"><outputDirectory></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"><cleanFirst></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"><javadocOptions></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> |
| <configuration> |
| <javadocOptions> |
| <ignoreError>false</ignoreError> |
| <encoding>UTF-8</encoding> |
| <doclet>foo.bar.MyDoclet</doclet> |
| <docletArtifacts> |
| <docletArtifact> |
| <groupId>foo.bar</groupId> |
| <artifactId>foo.bar.mydocletartifact</artifactId> |
| <version>1.0</version> |
| </docletArtifact> |
| </docletArtifacts> |
| <includes> |
| <include>com.example.*</include> |
| </includes> |
| <excludes> |
| <exclude>com.example.internal.*</exclude> |
| </excludes> |
| <additionalArguments> |
| <additionalArgument>-windowtitle "The Window Title"</additionalArgument> |
| <additionalArgument>-nosince</additionalArgument> |
| </additionalArguments> |
| </javadocOptions> |
| </configuration> |
| </pre><br/><strong>User property is</strong>: <code>javadocOptions</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#scopes"><scopes></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"><skipTocGen></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"><sourceTypes></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"><tocFile></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"><tocOptions></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> |
| <configuration> |
| <tocOptions> |
| <mainLabel>My own label</mainLabel> |
| <mainFilename>myOverviewSummary.html</mainFilename> |
| </tocOptions> |
| </configuration> |
| </pre><br/><strong>User property is</strong>: <code>tocOptions</code>.<br/></td> |
| </tr> |
| </table> |
| </subsection> |
| <subsection name="Parameter Details"> |
| <h4><strong><a name="buildDirectory"><buildDirectory></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"><cleanFirst></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"><javadocOptions></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> |
| <configuration> |
| <javadocOptions> |
| <ignoreError>false</ignoreError> |
| <encoding>UTF-8</encoding> |
| <doclet>foo.bar.MyDoclet</doclet> |
| <docletArtifacts> |
| <docletArtifact> |
| <groupId>foo.bar</groupId> |
| <artifactId>foo.bar.mydocletartifact</artifactId> |
| <version>1.0</version> |
| </docletArtifact> |
| </docletArtifacts> |
| <includes> |
| <include>com.example.*</include> |
| </includes> |
| <excludes> |
| <exclude>com.example.internal.*</exclude> |
| </excludes> |
| <additionalArguments> |
| <additionalArgument>-windowtitle "The Window Title"</additionalArgument> |
| <additionalArgument>-nosince</additionalArgument> |
| </additionalArguments> |
| </javadocOptions> |
| </configuration> |
| </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"><outputDirectory></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"><scopes></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"><skipTocGen></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"><sourceTypes></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"><tocFile></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"><tocOptions></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> |
| <configuration> |
| <tocOptions> |
| <mainLabel>My own label</mainLabel> |
| <mainFilename>myOverviewSummary.html</mainFilename> |
| </tocOptions> |
| </configuration> |
| </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> |