| <?xml version="1.0" encoding="UTF-8"?> |
| |
| <!-- Generated by maven-plugin-tools 3.6 --> |
| |
| <plugin> |
| <name>Tycho Document Bundle Plugin</name> |
| <description>Additional tools for Tycho</description> |
| <groupId>org.eclipse.tycho.extras</groupId> |
| <artifactId>tycho-document-bundle-plugin</artifactId> |
| <version>1.5.1-SNAPSHOT</version> |
| <goalPrefix>tycho-document-bundle</goalPrefix> |
| <isolatedRealm>false</isolatedRealm> |
| <inheritedByDefault>true</inheritedByDefault> |
| <mojos> |
| <mojo> |
| <goal>javadoc</goal> |
| <description>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.</description> |
| <requiresDependencyResolution>compile+runtime</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>process-classes</phase> |
| <implementation>org.eclipse.tycho.extras.docbundle.JavadocMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <since>0.20.0</since> |
| <threadSafe>false</threadSafe> |
| <parameters> |
| <parameter> |
| <name>basedir</name> |
| <type>java.io.File</type> |
| <required>true</required> |
| <editable>false</editable> |
| <description>The base output directory</description> |
| </parameter> |
| <parameter> |
| <name>buildDirectory</name> |
| <type>java.io.File</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The build directory where temporary build files will be placed</description> |
| </parameter> |
| <parameter> |
| <name>cleanFirst</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>An option to clean out the whole outputDirectory first.</description> |
| </parameter> |
| <parameter> |
| <name>javadocOptions</name> |
| <type>org.eclipse.tycho.extras.docbundle.JavadocOptions</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>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></description> |
| </parameter> |
| <parameter> |
| <name>outputDirectory</name> |
| <type>java.io.File</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The directory where the javadoc content will be generated</description> |
| </parameter> |
| <parameter> |
| <name>projectBuildSourceEncoding</name> |
| <type>java.lang.String</type> |
| <required>false</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>reactorProjects</name> |
| <type>java.util.List</type> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>scopes</name> |
| <type>java.util.Set</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The scopes that the dependencies must have in order to be included</description> |
| </parameter> |
| <parameter> |
| <name>session</name> |
| <type>org.apache.maven.execution.MavenSession</type> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>skipTocGen</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Set this property to true to skip the generation of the Eclipse TOC files.</description> |
| </parameter> |
| <parameter> |
| <name>sourceTypes</name> |
| <type>java.util.Set</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Maven module types that will be used to include the source</description> |
| </parameter> |
| <parameter> |
| <name>tocFile</name> |
| <type>java.io.File</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The output location of the toc file.<br/> |
| This file will be overwritten.</description> |
| </parameter> |
| <parameter> |
| <name>tocOptions</name> |
| <type>org.eclipse.tycho.extras.docbundle.TocOptions</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>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") |
| </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></description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <basedir implementation="java.io.File">${basedir}</basedir> |
| <buildDirectory implementation="java.io.File">${project.build.directory}</buildDirectory> |
| <cleanFirst implementation="boolean" default-value="true">${cleanFirst}</cleanFirst> |
| <javadocOptions implementation="org.eclipse.tycho.extras.docbundle.JavadocOptions">${javadocOptions}</javadocOptions> |
| <outputDirectory implementation="java.io.File" default-value="${project.build.directory}/reference/api">${outputDirectory}</outputDirectory> |
| <projectBuildSourceEncoding implementation="java.lang.String">${project.build.sourceEncoding}</projectBuildSourceEncoding> |
| <reactorProjects implementation="java.util.List">${reactorProjects}</reactorProjects> |
| <scopes implementation="java.util.Set" default-value="compile,provided">${scopes}</scopes> |
| <session implementation="org.apache.maven.execution.MavenSession">${session}</session> |
| <skipTocGen implementation="boolean" default-value="false">${skipTocGen}</skipTocGen> |
| <sourceTypes implementation="java.util.Set" default-value="eclipse-plugin">${sourceTypes}</sourceTypes> |
| <tocFile implementation="java.io.File" default-value="${project.build.directory}/tocjavadoc.xml">${tocFile}</tocFile> |
| <tocOptions implementation="org.eclipse.tycho.extras.docbundle.TocOptions">${tocOptions}</tocOptions> |
| </configuration> |
| <requirements> |
| <requirement> |
| <role>org.eclipse.tycho.core.osgitools.BundleReader</role> |
| <field-name>bundleReader</field-name> |
| </requirement> |
| <requirement> |
| <role>org.eclipse.tycho.extras.docbundle.DocletArtifactsResolver</role> |
| <field-name>docletArtifactsResolver</field-name> |
| </requirement> |
| <requirement> |
| <role>org.eclipse.tycho.core.TychoProject</role> |
| <field-name>projectTypes</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.toolchain.ToolchainManager</role> |
| <field-name>toolchainManager</field-name> |
| </requirement> |
| </requirements> |
| </mojo> |
| </mojos> |
| <dependencies> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-artifact</artifactId> |
| <type>jar</type> |
| <version>3.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>tycho-p2-facade</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160539-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-component-annotations</artifactId> |
| <type>jar</type> |
| <version>1.7.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>tycho-core</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160441-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.platform</groupId> |
| <artifactId>org.eclipse.osgi.compatibility.state</artifactId> |
| <type>jar</type> |
| <version>1.1.600</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>tycho-metadata-model</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160420-1</version> |
| </dependency> |
| <dependency> |
| <groupId>de.pdark</groupId> |
| <artifactId>decentxml</artifactId> |
| <type>jar</type> |
| <version>1.3</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>tycho-embedder-api</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160423-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>org.eclipse.tycho.embedder.shared</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160116-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>sisu-equinox-embedder</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160413-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.platform</groupId> |
| <artifactId>org.eclipse.osgi</artifactId> |
| <type>jar</type> |
| <version>3.15.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>sisu-equinox-api</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160408-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>org.eclipse.tycho.p2.resolver.shared</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160126-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>org.eclipse.tycho.p2.tools.shared</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160127-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>org.eclipse.tycho.core.shared</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160122-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho.extras</groupId> |
| <artifactId>tycho-p2-extras-plugin</artifactId> |
| <type>maven-plugin</type> |
| <version>1.5.1-20191024.161609-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>tycho-artifactcomparator</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160704-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.ow2.asm</groupId> |
| <artifactId>asm-tree</artifactId> |
| <type>jar</type> |
| <version>7.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.ow2.asm</groupId> |
| <artifactId>asm</artifactId> |
| <type>jar</type> |
| <version>7.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.ow2.asm</groupId> |
| <artifactId>asm-util</artifactId> |
| <type>jar</type> |
| <version>7.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.ow2.asm</groupId> |
| <artifactId>asm-analysis</artifactId> |
| <type>jar</type> |
| <version>7.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.eclipse.tycho</groupId> |
| <artifactId>sisu-equinox-launching</artifactId> |
| <type>jar</type> |
| <version>1.5.1-20191024.160444-1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-exec</artifactId> |
| <type>jar</type> |
| <version>1.2</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-lang3</artifactId> |
| <type>jar</type> |
| <version>3.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-core</artifactId> |
| <type>jar</type> |
| <version>3.0.3</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-settings-builder</artifactId> |
| <type>jar</type> |
| <version>3.0.3</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-repository-metadata</artifactId> |
| <type>jar</type> |
| <version>3.0.3</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.aether</groupId> |
| <artifactId>aether-impl</artifactId> |
| <type>jar</type> |
| <version>1.11</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.aether</groupId> |
| <artifactId>aether-api</artifactId> |
| <type>jar</type> |
| <version>1.11</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.aether</groupId> |
| <artifactId>aether-util</artifactId> |
| <type>jar</type> |
| <version>1.11</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-classworlds</artifactId> |
| <type>jar</type> |
| <version>2.4</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.plexus</groupId> |
| <artifactId>plexus-sec-dispatcher</artifactId> |
| <type>jar</type> |
| <version>1.3</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.plexus</groupId> |
| <artifactId>plexus-cipher</artifactId> |
| <type>jar</type> |
| <version>1.4</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-plugin-api</artifactId> |
| <type>jar</type> |
| <version>3.0.3</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-aether-provider</artifactId> |
| <type>jar</type> |
| <version>3.0.3</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.aether</groupId> |
| <artifactId>aether-spi</artifactId> |
| <type>jar</type> |
| <version>1.11</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-utils</artifactId> |
| <type>jar</type> |
| <version>3.0.24</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-archiver</artifactId> |
| <type>jar</type> |
| <version>3.4</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-io</artifactId> |
| <type>jar</type> |
| <version>2.7.1</version> |
| </dependency> |
| <dependency> |
| <groupId>commons-io</groupId> |
| <artifactId>commons-io</artifactId> |
| <type>jar</type> |
| <version>2.5</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-compress</artifactId> |
| <type>jar</type> |
| <version>1.18</version> |
| </dependency> |
| <dependency> |
| <groupId>org.iq80.snappy</groupId> |
| <artifactId>snappy</artifactId> |
| <type>jar</type> |
| <version>0.4</version> |
| </dependency> |
| <dependency> |
| <groupId>org.tukaani</groupId> |
| <artifactId>xz</artifactId> |
| <type>jar</type> |
| <version>1.5</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-settings</artifactId> |
| <type>jar</type> |
| <version>3.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-interpolation</artifactId> |
| <type>jar</type> |
| <version>1.14</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.sisu</groupId> |
| <artifactId>sisu-inject-plexus</artifactId> |
| <type>jar</type> |
| <version>1.4.2</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.sisu</groupId> |
| <artifactId>sisu-inject-bean</artifactId> |
| <type>jar</type> |
| <version>1.4.2</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.sisu</groupId> |
| <artifactId>sisu-guice</artifactId> |
| <type>jar</type> |
| <version>2.1.7</version> |
| </dependency> |
| </dependencies> |
| </plugin> |