sitedocs-extras/tycho-document-bundle-plugin/plugin-info.html - www.eclipse.org/tycho - Git at Google

 <!DOCTYPE html>
 <!--
  | Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-plugin-plugin:3.5.2:report at 2019-04-05
  | 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="20190405" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Tycho Document Bundle Plugin &#x2013; Plugin Documentation</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: 2019-04-05<span class="divider">|</span>
 </li>
           <li id="projectVersion">Version: 1.4.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 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" >
 <div class="section">
 <h2><a name="Plugin_Documentation"></a>Plugin Documentation</h2><a name="Plugin_Documentation"></a>
 <p>Goals available for this plugin:</p>
 <table border="0" class="table table-striped">
 <tr class="a">
 <th>Goal</th>
 <th>Description</th></tr>
 <tr class="b">
 <td><a href="javadoc-mojo.html">tycho-document-bundle:javadoc</a></td>
 <td>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.</td></tr></table>
 <div class="section">
 <h3><a name="System_Requirements"></a>System Requirements</h3><a name="System_Requirements"></a>
 <p>The following specifies the minimum requirements to run this Maven plugin:</p>
 <table border="0" class="table table-striped">
 <tr class="a">
 <td>Maven</td>
 <td>3.0</td></tr>
 <tr class="b">
 <td>JDK</td>
 <td>1.8</td></tr>
 <tr class="a">
 <td>Memory</td>
 <td>No minimum requirement.</td></tr>
 <tr class="b">
 <td>Disk Space</td>
 <td>No minimum requirement.</td></tr></table></div>
 <div class="section">
 <h3><a name="Usage"></a>Usage</h3><a name="Usage"></a>
 <p>You should specify the version in your project's plugin configuration:</p>
 <div class="source"><pre class="prettyprint">&lt;project&gt;
   ...
   &lt;build&gt;
     &lt;!-- To define the plugin version in your parent POM --&gt;
     &lt;pluginManagement&gt;
       &lt;plugins&gt;
         &lt;plugin&gt;
           &lt;groupId&gt;org.eclipse.tycho.extras&lt;/groupId&gt;
           &lt;artifactId&gt;tycho-document-bundle-plugin&lt;/artifactId&gt;
           &lt;version&gt;1.4.0&lt;/version&gt;
         &lt;/plugin&gt;
         ...
       &lt;/plugins&gt;
     &lt;/pluginManagement&gt;
     &lt;!-- To use the plugin goals in your POM or parent POM --&gt;
     &lt;plugins&gt;
       &lt;plugin&gt;
         &lt;groupId&gt;org.eclipse.tycho.extras&lt;/groupId&gt;
         &lt;artifactId&gt;tycho-document-bundle-plugin&lt;/artifactId&gt;
         &lt;version&gt;1.4.0&lt;/version&gt;
       &lt;/plugin&gt;
       ...
     &lt;/plugins&gt;
   &lt;/build&gt;
   ...
 &lt;/project&gt;
 </pre></div>
 <p>For more information, see <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">&quot;Guide to Configuring Plug-ins&quot;</a></p></div></div>
         </div>
       </div>
     </div>
     <hr/>
     <footer>
       <div class="container-fluid">
         <div class="row-fluid">
             <p>Copyright &copy;2010&#x2013;2019
 <a href="http://www.eclipse.org/">Eclipse Foundation</a>.
 All rights reserved.</p>
         </div>
       </div>
     </footer>
   </body>
 </html>
	<!DOCTYPE html>
	<!--
	\| Generated by Apache Maven Doxia Site Renderer 1.8.1 from org.apache.maven.plugins:maven-plugin-plugin:3.5.2:report at 2019-04-05
	\| 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="20190405" />
	<meta http-equiv="Content-Language" content="en" />
	<title>Tycho Document Bundle Plugin – Plugin Documentation</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: 2019-04-05<span class="divider">\|</span>
	</li>
	<li id="projectVersion">Version: 1.4.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 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" >
	<div class="section">
	<h2><a name="Plugin_Documentation"></a>Plugin Documentation</h2><a name="Plugin_Documentation"></a>
	<p>Goals available for this plugin:</p>
	<table border="0" class="table table-striped">
	<tr class="a">
	<th>Goal</th>
	<th>Description</th></tr>
	<tr class="b">
	<td><a href="javadoc-mojo.html">tycho-document-bundle:javadoc</a></td>
	<td>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.</td></tr></table>
	<div class="section">
	<h3><a name="System_Requirements"></a>System Requirements</h3><a name="System_Requirements"></a>
	<p>The following specifies the minimum requirements to run this Maven plugin:</p>
	<table border="0" class="table table-striped">
	<tr class="a">
	<td>Maven</td>
	<td>3.0</td></tr>
	<tr class="b">
	<td>JDK</td>
	<td>1.8</td></tr>
	<tr class="a">
	<td>Memory</td>
	<td>No minimum requirement.</td></tr>
	<tr class="b">
	<td>Disk Space</td>
	<td>No minimum requirement.</td></tr></table></div>
	<div class="section">
	<h3><a name="Usage"></a>Usage</h3><a name="Usage"></a>
	<p>You should specify the version in your project's plugin configuration:</p>
	<div class="source"><pre class="prettyprint"><project>
	...
	<build>
	<!-- To define the plugin version in your parent POM -->
	<pluginManagement>
	<plugins>
	<plugin>
	<groupId>org.eclipse.tycho.extras</groupId>
	<artifactId>tycho-document-bundle-plugin</artifactId>
	<version>1.4.0</version>
	</plugin>
	...
	</plugins>
	</pluginManagement>
	<!-- To use the plugin goals in your POM or parent POM -->
	<plugins>
	<plugin>
	<groupId>org.eclipse.tycho.extras</groupId>
	<artifactId>tycho-document-bundle-plugin</artifactId>
	<version>1.4.0</version>
	</plugin>
	...
	</plugins>
	</build>
	...
	</project>
	</pre></div>
	<p>For more information, see <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">"Guide to Configuring Plug-ins"</a></p></div></div>
	</div>
	</div>
	</div>
	<hr/>
	<footer>
	<div class="container-fluid">
	<div class="row-fluid">
	<p>Copyright ©2010–2019
	<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
	All rights reserved.</p>
	</div>
	</div>
	</footer>
	</body>
	</html>