| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.1 from target/generated-site/xdoc/javadoc-mojo.xml at 2020-01-13 |
| | Rendered using Apache Maven Fluido Skin 1.7 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20200113" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Tycho Document Bundle Plugin – tycho-document-bundle:javadoc</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h2>Tycho Document Bundle Plugin</h2> |
| </div> |
| </div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2020-01-13<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.6.0</li> |
| </ul> |
| </div> |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Tycho</li> |
| <li><a href="../../index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="../../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin"><span class="none"></span>Compiler Plugin</a></li> |
| <li><a href="../../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin"><span class="none"></span>Packaging Plugin</a></li> |
| <li><a href="../../BuildProperties.html" title="Build Properties"><span class="none"></span>Build Properties</a></li> |
| <li><a href="../../tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin"><span class="none"></span>Surefire Plugin</a></li> |
| <li><a href="../../tycho-p2/tycho-p2-publisher-plugin/plugin-info.html" title="p2 Publisher Plugin"><span class="none"></span>p2 Publisher Plugin</a></li> |
| <li><a href="../../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="p2 Repository Plugin"><span class="none"></span>p2 Repository Plugin</a></li> |
| <li><a href="../../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="p2 Director Plugin"><span class="none"></span>p2 Director Plugin</a></li> |
| <li><a href="../../tycho-source-plugin/plugin-info.html" title="Source Plugin"><span class="none"></span>Source Plugin</a></li> |
| <li><a href="../../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin"><span class="none"></span>Versions Plugin</a></li> |
| <li><a href="../../tycho-pomgenerator-plugin/plugin-info.html" title="POM Generator Plugin"><span class="none"></span>POM Generator Plugin</a></li> |
| <li><a href="../../TychoProperties.html" title="Tycho Properties"><span class="none"></span>Tycho Properties</a></li> |
| <li class="nav-header">Tycho Extras</li> |
| <li><a href="../index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="../tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin"><span class="none"></span>P2 Extras Plugin</a></li> |
| <li><a href="../target-platform-validation-plugin/plugin-info.html" title="Target Platform Validation Plugin"><span class="none"></span>Target Platform Validation Plugin</a></li> |
| <li><a href="../tycho-eclipserun-plugin/plugin-info.html" title="Eclipserun Plugin"><span class="none"></span>Eclipserun Plugin</a></li> |
| <li><a href="../tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin"><span class="none"></span>Document Bundle Plugin</a></li> |
| <li><a href="../tycho-source-feature-plugin/plugin-info.html" title="Source Feature Generation Plugin"><span class="none"></span>Source Feature Generation Plugin</a></li> |
| <li><a href="../tycho-pack200/index.html" title="Pack200 Plugins"><span class="icon-chevron-down"></span>Pack200 Plugins</a> |
| <ul class="nav nav-list"> |
| <li><a href="../tycho-pack200/tycho-pack200a-plugin/plugin-info.html" title="Normalization Plugin"><span class="none"></span>Normalization Plugin</a></li> |
| <li><a href="../tycho-pack200/tycho-pack200b-plugin/plugin-info.html" title="Pack Plugin"><span class="none"></span>Pack Plugin</a></li> |
| </ul> |
| </li> |
| </ul> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </div> |
| <div id="bodyColumn" class="span10" > |
| |
| |
| <section> |
| <h2><a name="tycho-document-bundle:javadoc"></a>tycho-document-bundle:javadoc</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.tycho.extras:tycho-document-bundle-plugin:1.6.0:javadoc</p> |
| |
| <p><b>Description</b>:</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><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Requires dependency resolution of artifacts in scope: compile+runtime.</li> |
| |
| <li>Since version: 0.20.0.</li> |
| |
| <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: process-classes.</li> |
| </ul> |
| <section> |
| <h3><a name="Required_Parameters"></a>Required Parameters</h3> |
| |
| <table class="table table-striped" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#buildDirectory"><buildDirectory></a></td> |
| |
| <td>File</td> |
| |
| <td>0.20.0</td> |
| |
| <td>The build directory where temporary build files will be placed<br /><b>User property is</b>: project.build.directory.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#outputDirectory"><outputDirectory></a></td> |
| |
| <td>File</td> |
| |
| <td>0.20.0</td> |
| |
| <td>The directory where the javadoc content will be generated<br /><b>Default value is</b>: ${project.build.directory}/reference/api.<br /><b>User property is</b>: outputDirectory.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</h3> |
| |
| <table class="table table-striped" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#cleanFirst"><cleanFirst></a></td> |
| |
| <td>boolean</td> |
| |
| <td>0.20.0</td> |
| |
| <td>An option to clean out the whole outputDirectory first.<br /><b>Default value is</b>: true.<br /><b>User property is</b>: cleanFirst.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#javadocOptions"><javadocOptions></a></td> |
| |
| <td>JavadocOptions</td> |
| |
| <td>0.20.0</td> |
| |
| <td>Options for calling the javadoc application. Possible options are |
| (all options are optional): |
| |
| <ul> |
| |
| <li>ignoreError, specifies if errors calling javadoc |
| should be ignored</li> |
| |
| <li>doclet, used as javadoc -doclet |
| parameter</li> |
| |
| <li>docletArtifacts, dependencies will be resovled and |
| added as -docletpath parameter</li> |
| |
| <li>encoding, used as javadoc -encoding parameter |
| (default: ${project.build.sourceEncoding}</li> |
| |
| <li>additionalArguments, a list of additional arguments |
| passed to javadoc</li> |
| |
| <li>includes/excludes, the list of names of |
| packages to be included in or excluded from JavaDoc processing; use |
| '*' character as wildcard</li> |
| </ul> |
| Example configuration: |
| |
| <div> |
| <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><br /><b>User property is</b>: javadocOptions.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#scopes"><scopes></a></td> |
| |
| <td>Set</td> |
| |
| <td>0.20.0</td> |
| |
| <td>The scopes that the dependencies must have in order to be included<br /><b>Default value is</b>: compile,provided.<br /><b>User property is</b>: scopes.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#skipTocGen"><skipTocGen></a></td> |
| |
| <td>boolean</td> |
| |
| <td>0.20.0</td> |
| |
| <td>Set this property to true to skip the generation of the Eclipse TOC |
| files.<br /><b>Default value is</b>: false.<br /><b>User property is</b>: skipTocGen.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#sourceTypes"><sourceTypes></a></td> |
| |
| <td>Set</td> |
| |
| <td>0.20.0</td> |
| |
| <td>Maven module types that will be used to include the source<br /><b>Default value is</b>: eclipse-plugin.<br /><b>User property is</b>: sourceTypes.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#tocFile"><tocFile></a></td> |
| |
| <td>File</td> |
| |
| <td>0.20.0</td> |
| |
| <td>The output location of the toc file.<br /> |
| This file will be overwritten.<br /><b>Default value is</b>: ${project.build.directory}/tocjavadoc.xml.<br /><b>User property is</b>: tocFile.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#tocOptions"><tocOptions></a></td> |
| |
| <td>TocOptions</td> |
| |
| <td>0.20.0</td> |
| |
| <td>Options for creating the toc files. |
| |
| <ul> |
| |
| <li>mainLabel, specifies the main label of the toc file |
| (default: "API Reference")</li> |
| |
| <li>mainFilename, specifies the filename of the TOC file |
| (default: "overview-summary.html")</li> |
| </ul> |
| Example configuration: |
| |
| <div> |
| <pre> |
| <configuration> |
| <tocOptions> |
| <mainLabel>My own label</mainLabel> |
| <mainFilename>myOverviewSummary.html</mainFilename> |
| </tocOptions> |
| </configuration> |
| </pre></div><br /><b>User property is</b>: tocOptions.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3CbuildDirectory.3E"></a><b><a name="buildDirectory"><buildDirectory></a></b></h4> |
| |
| <div>The build directory where temporary build files will be placed</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.io.File</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: Yes</li> |
| |
| <li><b>User Property</b>: project.build.directory</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CcleanFirst.3E"></a><b><a name="cleanFirst"><cleanFirst></a></b></h4> |
| |
| <div>An option to clean out the whole outputDirectory first.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: cleanFirst</li> |
| |
| <li><b>Default</b>: true</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CjavadocOptions.3E"></a><b><a name="javadocOptions"><javadocOptions></a></b></h4> |
| |
| <div>Options for calling the javadoc application. Possible options are |
| (all options are optional): |
| |
| <ul> |
| |
| <li>ignoreError, specifies if errors calling javadoc |
| should be ignored</li> |
| |
| <li>doclet, used as javadoc -doclet |
| parameter</li> |
| |
| <li>docletArtifacts, dependencies will be resovled and |
| added as -docletpath parameter</li> |
| |
| <li>encoding, used as javadoc -encoding parameter |
| (default: ${project.build.sourceEncoding}</li> |
| |
| <li>additionalArguments, a list of additional arguments |
| passed to javadoc</li> |
| |
| <li>includes/excludes, the list of names of |
| packages to be included in or excluded from JavaDoc processing; use |
| '*' character as wildcard</li> |
| </ul> |
| Example configuration: |
| |
| <div> |
| <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></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: org.eclipse.tycho.extras.docbundle.JavadocOptions</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: javadocOptions</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CoutputDirectory.3E"></a><b><a name="outputDirectory"><outputDirectory></a></b></h4> |
| |
| <div>The directory where the javadoc content will be generated</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.io.File</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: Yes</li> |
| |
| <li><b>User Property</b>: outputDirectory</li> |
| |
| <li><b>Default</b>: ${project.build.directory}/reference/api</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cscopes.3E"></a><b><a name="scopes"><scopes></a></b></h4> |
| |
| <div>The scopes that the dependencies must have in order to be included</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.util.Set</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: scopes</li> |
| |
| <li><b>Default</b>: compile,provided</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CskipTocGen.3E"></a><b><a name="skipTocGen"><skipTocGen></a></b></h4> |
| |
| <div>Set this property to true to skip the generation of the Eclipse TOC |
| files.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: skipTocGen</li> |
| |
| <li><b>Default</b>: false</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CsourceTypes.3E"></a><b><a name="sourceTypes"><sourceTypes></a></b></h4> |
| |
| <div>Maven module types that will be used to include the source</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.util.Set</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: sourceTypes</li> |
| |
| <li><b>Default</b>: eclipse-plugin</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtocFile.3E"></a><b><a name="tocFile"><tocFile></a></b></h4> |
| |
| <div>The output location of the toc file.<br /> |
| This file will be overwritten.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.io.File</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: tocFile</li> |
| |
| <li><b>Default</b>: ${project.build.directory}/tocjavadoc.xml</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtocOptions.3E"></a><b><a name="tocOptions"><tocOptions></a></b></h4> |
| |
| <div>Options for creating the toc files. |
| |
| <ul> |
| |
| <li>mainLabel, specifies the main label of the toc file |
| (default: "API Reference")</li> |
| |
| <li>mainFilename, specifies the filename of the TOC file |
| (default: "overview-summary.html")</li> |
| </ul> |
| Example configuration: |
| |
| <div> |
| <pre> |
| <configuration> |
| <tocOptions> |
| <mainLabel>My own label</mainLabel> |
| <mainFilename>myOverviewSummary.html</mainFilename> |
| </tocOptions> |
| </configuration> |
| </pre></div></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: org.eclipse.tycho.extras.docbundle.TocOptions</li> |
| |
| <li><b>Since</b>: 0.20.0</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: tocOptions</li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2008–2020 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |