sitedocs-extras/tycho-source-feature-plugin/target/generated-site/xdoc/source-feature-mojo.xml - gerrit/www.eclipse.org/tycho - Git at Google

 <?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-source-feature:source-feature</title>
   </properties>
   <body>
     <section name="tycho-source-feature:source-feature">
       <p><strong>Full name</strong>:</p>
       <p>org.eclipse.tycho.extras:tycho-source-feature-plugin:1.5.1-SNAPSHOT:source-feature</p>
       <p><strong>Description</strong>:</p>
       <div>Generates a source feature for projects of packaging type
 <code>eclipse-feature</code>. By default, the generated source
 feature
 <ul>
 <li>Declares feature id
 <code>&lt;originalFeatureId&gt;.source</code></li>
 <li>Declares feature label <code>"&lt;originalFeatureLabel&gt;
 Developer Resources"</code></li>
 <li>If present, reuses feature provider, description, copyright and
 license as well as respective URLs from
 &lt;originalFeature&gt;</li>
 <li>Includes all plugins included by &lt;originalFeature&gt;, but
 each with <code>.source</code> appended to each plugin id</li>
 <li>Includes all features included by &lt;originalFeature&gt;, but
 each with <code>.source</code> appended to each feature id</li>
 <li>Includes the original feature. This ensures that binaries and
 corresponding sources match.</li>
 </ul>
 Source feature generation can be customized by adding files under
 path <code>sourceTemplateFeature/</code>. Files added here will be
 added to the root of the source feature jar. Especially, if file
 <code>sourceTemplateFeature/feature.properties</code> is found,
 values in this file override values of respective keys in
 <code>&lt;originalFeature&gt;/feature.properties</code>.</div>
       <p><strong>Attributes</strong>:</p>
       <ul>
         <li>Requires a Maven project to be executed.</li>
         <li>Binds by default to the <a href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>package</code>.</li>
       </ul>
       <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="#archive">&lt;archive&gt;</a></code></td>
             <td><code>MavenArchiveConfiguration</code></td>
             <td><code>-</code></td>
             <td>(no description)<br/></td>
           </tr>
           <tr>
             <td><code><a href="#brandingPlugin">&lt;brandingPlugin&gt;</a></code></td>
             <td><code>String</code></td>
             <td><code>-</code></td>
             <td>Use this to explicitly set the <a
 href="http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Feditors%2Ffeature_editor%2Ffeature_editor.htm">branding
 plugin attribute</a> of the generated source feature (overrides
 <code>reuseBrandingPlugin</code>).<br/></td>
           </tr>
           <tr>
             <td><code><a href="#excludes">&lt;excludes&gt;</a></code></td>
             <td><code>PlexusConfiguration</code></td>
             <td><code>-</code></td>
             <td>Bundles and features that do not have corresponding sources.
 Example:
 <pre>
 &lt;excludes&gt;
   &lt;plugin id="plugin.nosource"/&gt;
   &lt;feature id="feature.nosource"/&gt;
 &lt;/excludes&gt;
 </pre><br/></td>
           </tr>
           <tr>
             <td><code><a href="#finalName">&lt;finalName&gt;</a></code></td>
             <td><code>String</code></td>
             <td><code>-</code></td>
             <td>The filename to be used for the generated archive file. For the
 source-feature goal, "-sources-feature" is appended to this
 filename.<br/><strong>User property is</strong>: <code>project.build.finalName</code>.<br/></td>
           </tr>
           <tr>
             <td><code><a href="#includeBinaryFeature">&lt;includeBinaryFeature&gt;</a></code></td>
             <td><code>boolean</code></td>
             <td><code>-</code></td>
             <td>Whether to add an include dependency from the source feature to the
 corresponding binary feature. If <code>true</code>, this ensures
 the version of the installed sources matches the binaries.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td>
           </tr>
           <tr>
             <td><code><a href="#labelSuffix">&lt;labelSuffix&gt;</a></code></td>
             <td><code>String</code></td>
             <td><code>-</code></td>
             <td>Source feature label suffix. Unless explicitly provided in
 <code>sourceTemplateFeature/feature.properties</code>, this suffix
 will be appended to the original feature label to construct the
 source feature label.<br/><strong>Default value is</strong>: <code> Developer Resources</code>.<br/></td>
           </tr>
           <tr>
             <td><code><a href="#plugins">&lt;plugins&gt;</a></code></td>
             <td><code>PlexusConfiguration</code></td>
             <td><code>-</code></td>
             <td>Additional plugins to include in the generated source feature.
 Beware that these additional plugins are not considered during
 build target platform calculation and ordering of reactor projects.
 Use &lt;extraRequirements&gt; dependency resolver configuration to
 guarantee proper reactor build order.
 <p><strong>WARNING</strong> This experimental parameter may be
 removed from future source-feature mojo versions without prior
 notice.</p><br/></td>
           </tr>
           <tr>
             <td><code><a href="#reuseBrandingPlugin">&lt;reuseBrandingPlugin&gt;</a></code></td>
             <td><code>boolean</code></td>
             <td><code>-</code></td>
             <td>Whether to reuse an explicit branding plugin from the binary
 feature for the generated source feature.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td>
           </tr>
           <tr>
             <td><code><a href="#skip">&lt;skip&gt;</a></code></td>
             <td><code>boolean</code></td>
             <td><code>-</code></td>
             <td>Whether to skip source feature generation.<br/><strong>Default value is</strong>: <code>false</code>.<br/></td>
           </tr>
         </table>
       </subsection>
       <subsection name="Parameter Details">
         <h4><strong><a name="archive">&lt;archive&gt;</a></strong></h4>
         <div>(no description)</div>
         <ul>
           <li><strong>Type</strong>: <code>org.apache.maven.archiver.MavenArchiveConfiguration</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
         </ul><hr/><h4><strong><a name="brandingPlugin">&lt;brandingPlugin&gt;</a></strong></h4>
         <div>Use this to explicitly set the <a
 href="http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Feditors%2Ffeature_editor%2Ffeature_editor.htm">branding
 plugin attribute</a> of the generated source feature (overrides
 <code>reuseBrandingPlugin</code>).</div>
         <ul>
           <li><strong>Type</strong>: <code>java.lang.String</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
         </ul><hr/><h4><strong><a name="excludes">&lt;excludes&gt;</a></strong></h4>
         <div>Bundles and features that do not have corresponding sources.
 Example:
 <pre>
 &lt;excludes&gt;
   &lt;plugin id="plugin.nosource"/&gt;
   &lt;feature id="feature.nosource"/&gt;
 &lt;/excludes&gt;
 </pre></div>
         <ul>
           <li><strong>Type</strong>: <code>org.codehaus.plexus.configuration.PlexusConfiguration</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
         </ul><hr/><h4><strong><a name="finalName">&lt;finalName&gt;</a></strong></h4>
         <div>The filename to be used for the generated archive file. For the
 source-feature goal, "-sources-feature" is appended to this
 filename.</div>
         <ul>
           <li><strong>Type</strong>: <code>java.lang.String</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
           <li><strong>User Property</strong>: <code>project.build.finalName</code></li>
         </ul><hr/><h4><strong><a name="includeBinaryFeature">&lt;includeBinaryFeature&gt;</a></strong></h4>
         <div>Whether to add an include dependency from the source feature to the
 corresponding binary feature. If <code>true</code>, this ensures
 the version of the installed sources matches the binaries.</div>
         <ul>
           <li><strong>Type</strong>: <code>boolean</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
           <li><strong>Default</strong>: <code>true</code></li>
         </ul><hr/><h4><strong><a name="labelSuffix">&lt;labelSuffix&gt;</a></strong></h4>
         <div>Source feature label suffix. Unless explicitly provided in
 <code>sourceTemplateFeature/feature.properties</code>, this suffix
 will be appended to the original feature label to construct the
 source feature label.</div>
         <ul>
           <li><strong>Type</strong>: <code>java.lang.String</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
           <li><strong>Default</strong>: <code> Developer Resources</code></li>
         </ul><hr/><h4><strong><a name="plugins">&lt;plugins&gt;</a></strong></h4>
         <div>Additional plugins to include in the generated source feature.
 Beware that these additional plugins are not considered during
 build target platform calculation and ordering of reactor projects.
 Use &lt;extraRequirements&gt; dependency resolver configuration to
 guarantee proper reactor build order.
 <p><strong>WARNING</strong> This experimental parameter may be
 removed from future source-feature mojo versions without prior
 notice.</p></div>
         <ul>
           <li><strong>Type</strong>: <code>org.codehaus.plexus.configuration.PlexusConfiguration</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
         </ul><hr/><h4><strong><a name="reuseBrandingPlugin">&lt;reuseBrandingPlugin&gt;</a></strong></h4>
         <div>Whether to reuse an explicit branding plugin from the binary
 feature for the generated source feature.</div>
         <ul>
           <li><strong>Type</strong>: <code>boolean</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
           <li><strong>Default</strong>: <code>true</code></li>
         </ul><hr/><h4><strong><a name="skip">&lt;skip&gt;</a></strong></h4>
         <div>Whether to skip source feature generation.</div>
         <ul>
           <li><strong>Type</strong>: <code>boolean</code></li>
           <li><strong>Required</strong>: <code>No</code></li>
           <li><strong>Default</strong>: <code>false</code></li>
         </ul>
       </subsection>
     </section>
   </body>
 </document>
	<?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-source-feature:source-feature</title>
	</properties>
	<body>
	<section name="tycho-source-feature:source-feature">
	<p><strong>Full name</strong>:</p>
	<p>org.eclipse.tycho.extras:tycho-source-feature-plugin:1.5.1-SNAPSHOT:source-feature</p>
	<p><strong>Description</strong>:</p>
	<div>Generates a source feature for projects of packaging type
	<code>eclipse-feature</code>. By default, the generated source
	feature
	<ul>
	<li>Declares feature id
	<code><originalFeatureId>.source</code></li>
	<li>Declares feature label <code>"<originalFeatureLabel>
	Developer Resources"</code></li>
	<li>If present, reuses feature provider, description, copyright and
	license as well as respective URLs from
	<originalFeature></li>
	<li>Includes all plugins included by <originalFeature>, but
	each with <code>.source</code> appended to each plugin id</li>
	<li>Includes all features included by <originalFeature>, but
	each with <code>.source</code> appended to each feature id</li>
	<li>Includes the original feature. This ensures that binaries and
	corresponding sources match.</li>
	</ul>
	Source feature generation can be customized by adding files under
	path <code>sourceTemplateFeature/</code>. Files added here will be
	added to the root of the source feature jar. Especially, if file
	<code>sourceTemplateFeature/feature.properties</code> is found,
	values in this file override values of respective keys in
	<code><originalFeature>/feature.properties</code>.</div>
	<p><strong>Attributes</strong>:</p>
	<ul>
	<li>Requires a Maven project to be executed.</li>
	<li>Binds by default to the <a href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>package</code>.</li>
	</ul>
	<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="#archive"><archive></a></code></td>
	<td><code>MavenArchiveConfiguration</code></td>
	<td><code>-</code></td>
	<td>(no description)<br/></td>
	</tr>
	<tr>
	<td><code><a href="#brandingPlugin"><brandingPlugin></a></code></td>
	<td><code>String</code></td>
	<td><code>-</code></td>
	<td>Use this to explicitly set the <a
	href="http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Feditors%2Ffeature_editor%2Ffeature_editor.htm">branding
	plugin attribute</a> of the generated source feature (overrides
	<code>reuseBrandingPlugin</code>).<br/></td>
	</tr>
	<tr>
	<td><code><a href="#excludes"><excludes></a></code></td>
	<td><code>PlexusConfiguration</code></td>
	<td><code>-</code></td>
	<td>Bundles and features that do not have corresponding sources.
	Example:
	<pre>
	<excludes>
	<plugin id="plugin.nosource"/>
	<feature id="feature.nosource"/>
	</excludes>
	</pre><br/></td>
	</tr>
	<tr>
	<td><code><a href="#finalName"><finalName></a></code></td>
	<td><code>String</code></td>
	<td><code>-</code></td>
	<td>The filename to be used for the generated archive file. For the
	source-feature goal, "-sources-feature" is appended to this
	filename.<br/><strong>User property is</strong>: <code>project.build.finalName</code>.<br/></td>
	</tr>
	<tr>
	<td><code><a href="#includeBinaryFeature"><includeBinaryFeature></a></code></td>
	<td><code>boolean</code></td>
	<td><code>-</code></td>
	<td>Whether to add an include dependency from the source feature to the
	corresponding binary feature. If <code>true</code>, this ensures
	the version of the installed sources matches the binaries.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td>
	</tr>
	<tr>
	<td><code><a href="#labelSuffix"><labelSuffix></a></code></td>
	<td><code>String</code></td>
	<td><code>-</code></td>
	<td>Source feature label suffix. Unless explicitly provided in
	<code>sourceTemplateFeature/feature.properties</code>, this suffix
	will be appended to the original feature label to construct the
	source feature label.<br/><strong>Default value is</strong>: <code> Developer Resources</code>.<br/></td>
	</tr>
	<tr>
	<td><code><a href="#plugins"><plugins></a></code></td>
	<td><code>PlexusConfiguration</code></td>
	<td><code>-</code></td>
	<td>Additional plugins to include in the generated source feature.
	Beware that these additional plugins are not considered during
	build target platform calculation and ordering of reactor projects.
	Use <extraRequirements> dependency resolver configuration to
	guarantee proper reactor build order.
	<p><strong>WARNING</strong> This experimental parameter may be
	removed from future source-feature mojo versions without prior
	notice.</p><br/></td>
	</tr>
	<tr>
	<td><code><a href="#reuseBrandingPlugin"><reuseBrandingPlugin></a></code></td>
	<td><code>boolean</code></td>
	<td><code>-</code></td>
	<td>Whether to reuse an explicit branding plugin from the binary
	feature for the generated source feature.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td>
	</tr>
	<tr>
	<td><code><a href="#skip"><skip></a></code></td>
	<td><code>boolean</code></td>
	<td><code>-</code></td>
	<td>Whether to skip source feature generation.<br/><strong>Default value is</strong>: <code>false</code>.<br/></td>
	</tr>
	</table>
	</subsection>
	<subsection name="Parameter Details">
	<h4><strong><a name="archive"><archive></a></strong></h4>
	<div>(no description)</div>
	<ul>
	<li><strong>Type</strong>: <code>org.apache.maven.archiver.MavenArchiveConfiguration</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	</ul><hr/><h4><strong><a name="brandingPlugin"><brandingPlugin></a></strong></h4>
	<div>Use this to explicitly set the <a
	href="http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Feditors%2Ffeature_editor%2Ffeature_editor.htm">branding
	plugin attribute</a> of the generated source feature (overrides
	<code>reuseBrandingPlugin</code>).</div>
	<ul>
	<li><strong>Type</strong>: <code>java.lang.String</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	</ul><hr/><h4><strong><a name="excludes"><excludes></a></strong></h4>
	<div>Bundles and features that do not have corresponding sources.
	Example:
	<pre>
	<excludes>
	<plugin id="plugin.nosource"/>
	<feature id="feature.nosource"/>
	</excludes>
	</pre></div>
	<ul>
	<li><strong>Type</strong>: <code>org.codehaus.plexus.configuration.PlexusConfiguration</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	</ul><hr/><h4><strong><a name="finalName"><finalName></a></strong></h4>
	<div>The filename to be used for the generated archive file. For the
	source-feature goal, "-sources-feature" is appended to this
	filename.</div>
	<ul>
	<li><strong>Type</strong>: <code>java.lang.String</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	<li><strong>User Property</strong>: <code>project.build.finalName</code></li>
	</ul><hr/><h4><strong><a name="includeBinaryFeature"><includeBinaryFeature></a></strong></h4>
	<div>Whether to add an include dependency from the source feature to the
	corresponding binary feature. If <code>true</code>, this ensures
	the version of the installed sources matches the binaries.</div>
	<ul>
	<li><strong>Type</strong>: <code>boolean</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	<li><strong>Default</strong>: <code>true</code></li>
	</ul><hr/><h4><strong><a name="labelSuffix"><labelSuffix></a></strong></h4>
	<div>Source feature label suffix. Unless explicitly provided in
	<code>sourceTemplateFeature/feature.properties</code>, this suffix
	will be appended to the original feature label to construct the
	source feature label.</div>
	<ul>
	<li><strong>Type</strong>: <code>java.lang.String</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	<li><strong>Default</strong>: <code> Developer Resources</code></li>
	</ul><hr/><h4><strong><a name="plugins"><plugins></a></strong></h4>
	<div>Additional plugins to include in the generated source feature.
	Beware that these additional plugins are not considered during
	build target platform calculation and ordering of reactor projects.
	Use <extraRequirements> dependency resolver configuration to
	guarantee proper reactor build order.
	<p><strong>WARNING</strong> This experimental parameter may be
	removed from future source-feature mojo versions without prior
	notice.</p></div>
	<ul>
	<li><strong>Type</strong>: <code>org.codehaus.plexus.configuration.PlexusConfiguration</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	</ul><hr/><h4><strong><a name="reuseBrandingPlugin"><reuseBrandingPlugin></a></strong></h4>
	<div>Whether to reuse an explicit branding plugin from the binary
	feature for the generated source feature.</div>
	<ul>
	<li><strong>Type</strong>: <code>boolean</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	<li><strong>Default</strong>: <code>true</code></li>
	</ul><hr/><h4><strong><a name="skip"><skip></a></strong></h4>
	<div>Whether to skip source feature generation.</div>
	<ul>
	<li><strong>Type</strong>: <code>boolean</code></li>
	<li><strong>Required</strong>: <code>No</code></li>
	<li><strong>Default</strong>: <code>false</code></li>
	</ul>
	</subsection>
	</section>
	</body>
	</document>