blob: dc6af58eacc917a865d62698d5584d01690ed38d [file] [log] [blame]
<?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-custom-bundle:custom-bundle</title>
</properties>
<body>
<section name="tycho-custom-bundle:custom-bundle">
<p><strong>Full name</strong>:</p>
<p>org.eclipse.tycho.extras:tycho-custom-bundle-plugin:1.5.1-SNAPSHOT:custom-bundle</p>
<p><strong>Description</strong>:</p>
<div>Builds OSGi bundle</div>
<p><strong>Attributes</strong>:</p>
<ul>
<li>Requires a Maven project to be executed.</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="#bundleLocation">&lt;bundleLocation&gt;</a></code></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>Location of OSGi bundle, must have META-INF/MANIFEST.MF bundle
manifest file.<br/></td>
</tr>
<tr>
<td><code><a href="#classifier">&lt;classifier&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Classifier of attached artifact.<br/></td>
</tr>
<tr>
<td><code><a href="#fileSets">&lt;fileSets&gt;</a></code></td>
<td><code>List</code></td>
<td><code>-</code></td>
<td>Additional files to be included in the generated bundle.<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="#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="#excludes">&lt;excludes&gt;</a></code></td>
<td><code>String[]</code></td>
<td><code>-</code></td>
<td>File patterns to exclude from bundleLocation.<br/></td>
</tr>
<tr>
<td><code><a href="#includes">&lt;includes&gt;</a></code></td>
<td><code>String[]</code></td>
<td><code>-</code></td>
<td>File patterns to include from bundleLocation. Include everything by
default.<br/></td>
</tr>
<tr>
<td><code><a href="#project">&lt;project&gt;</a></code></td>
<td><code>MavenProject</code></td>
<td><code>-</code></td>
<td>(no description)<br/><strong>User property is</strong>: <code>project</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="bundleLocation">&lt;bundleLocation&gt;</a></strong></h4>
<div>Location of OSGi bundle, must have META-INF/MANIFEST.MF bundle
manifest file.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
</ul><hr/><h4><strong><a name="classifier">&lt;classifier&gt;</a></strong></h4>
<div>Classifier of attached artifact.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
</ul><hr/><h4><strong><a name="excludes">&lt;excludes&gt;</a></strong></h4>
<div>File patterns to exclude from bundleLocation.</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="fileSets">&lt;fileSets&gt;</a></strong></h4>
<div>Additional files to be included in the generated bundle.</div>
<ul>
<li><strong>Type</strong>: <code>java.util.List</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
</ul><hr/><h4><strong><a name="includes">&lt;includes&gt;</a></strong></h4>
<div>File patterns to include from bundleLocation. Include everything by
default.</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="project">&lt;project&gt;</a></strong></h4>
<div>(no description)</div>
<ul>
<li><strong>Type</strong>: <code>org.apache.maven.project.MavenProject</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>project</code></li>
</ul>
</subsection>
</section>
</body>
</document>