| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2019-11-05 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <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="20191105" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Sisu Maven Plugin – sisu:index</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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.3.0.min.js"></script> |
| |
| |
| </head> |
| <body class="topBarEnabled"> |
| |
| |
| |
| |
| |
| <div id="topbar" class="navbar navbar-fixed-top "> |
| <div class="navbar-inner"> |
| <div class="container"><div class="nav-collapse"> |
| |
| |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| <li> <a href="index.html" title="Introduction">Introduction</a> |
| </li> |
| |
| <li> <a href="plugin-info.html" title="Goals">Goals</a> |
| </li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| <li class="dropdown-submenu"> |
| <a href="project-info.html" title="Project Information">Project Information</a> |
| <ul class="dropdown-menu"> |
| <li> <a href="index.html" title="About">About</a> |
| </li> |
| <li> <a href="plugin-management.html" title="Plugin Management">Plugin Management</a> |
| </li> |
| <li> <a href="distribution-management.html" title="Distribution Management">Distribution Management</a> |
| </li> |
| <li> <a href="dependency-info.html" title="Dependency Information">Dependency Information</a> |
| </li> |
| <li> <a href="source-repository.html" title="Source Repository">Source Repository</a> |
| </li> |
| <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a> |
| </li> |
| <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> |
| </li> |
| <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a> |
| </li> |
| <li> <a href="plugins.html" title="Project Plugins">Project Plugins</a> |
| </li> |
| <li> <a href="license.html" title="Project License">Project License</a> |
| </li> |
| <li> <a href="team-list.html" title="Project Team">Project Team</a> |
| </li> |
| <li> <a href="project-summary.html" title="Project Summary">Project Summary</a> |
| </li> |
| <li> <a href="dependencies.html" title="Dependencies">Dependencies</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="dropdown-submenu"> |
| <a href="project-reports.html" title="Project Reports">Project Reports</a> |
| <ul class="dropdown-menu"> |
| <li> <a href="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| |
| |
| <ul class="nav pull-right"> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li> <a href="http://eclipse.org/sisu/" title="Sisu">Sisu</a> |
| </li> |
| <li> <a href="http://maven.apache.org/" title="Maven">Maven</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <h2>Sisu Maven 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-11-05</li> |
| <li class="divider">|</li> <li id="projectVersion">Version: 0.3.4</li> |
| |
| |
| |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| |
| |
| <div class="section"> |
| <h2><a name="sisu:index"></a>sisu:index</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.sisu:sisu-maven-plugin:0.3.4:index</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Generates a qualified class index for the current project and its |
| dependencies.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li> |
| |
| <li>The goal is thread-safe and supports parallel builds.</li> |
| </ul> |
| |
| <div class="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><b><a href="#excludeArtifactIds">excludeArtifactIds</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma separated list of ArtifactIds to exclude when indexing.<br /><b>User property is</b>: <tt>excludeArtifactIds</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#excludeClassifiers">excludeClassifiers</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma Separated list of Classifiers to exclude when indexing.<br /><b>User property is</b>: <tt>excludeClassifiers</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#excludeGroupIds">excludeGroupIds</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma separated list of GroupIds to exclude when indexing.<br /><b>User property is</b>: <tt>excludeGroupIds</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#excludeScope">excludeScope</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Scope to exclude. Empty string indicates no scopes (default).<br /><b>User property is</b>: <tt>excludeScope</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#excludeTransitive">excludeTransitive</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If we should exclude transitive dependencies when indexing.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>excludeTransitive</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#excludeTypes">excludeTypes</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma Separated list of Types to exclude when indexing.<br /><b>User property is</b>: <tt>excludeTypes</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#includeArtifactIds">includeArtifactIds</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma separated list of ArtifactIds to include when indexing.<br /><b>User property is</b>: <tt>includeArtifactIds</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#includeClassifiers">includeClassifiers</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma Separated list of Classifiers to include when indexing.<br /><b>User property is</b>: <tt>includeClassifiers</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#includeDependencies">includeDependencies</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If we should include project dependencies when indexing.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>includeDependencies</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#includeGroupIds">includeGroupIds</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma separated list of GroupIds to include when indexing.<br /><b>User property is</b>: <tt>includeGroupIds</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#includeScope">includeScope</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Scope to include. Empty string indicates all scopes (default).<br /><b>User property is</b>: <tt>includeScope</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#includeTypes">includeTypes</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Comma Separated list of Types to include when indexing.<br /><b>User property is</b>: <tt>includeTypes</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#outputDirectory">outputDirectory</a></b></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>The output directory.<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>outputDirectory</tt>.</td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| |
| <p><b><a name="excludeArtifactIds">excludeArtifactIds</a>:</b></p> |
| |
| <div>Comma separated list of ArtifactIds to exclude when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>excludeArtifactIds</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludeClassifiers">excludeClassifiers</a>:</b></p> |
| |
| <div>Comma Separated list of Classifiers to exclude when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>excludeClassifiers</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludeGroupIds">excludeGroupIds</a>:</b></p> |
| |
| <div>Comma separated list of GroupIds to exclude when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>excludeGroupIds</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludeScope">excludeScope</a>:</b></p> |
| |
| <div>Scope to exclude. Empty string indicates no scopes (default).</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>excludeScope</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludeTransitive">excludeTransitive</a>:</b></p> |
| |
| <div>If we should exclude transitive dependencies when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>excludeTransitive</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /> |
| <p><b><a name="excludeTypes">excludeTypes</a>:</b></p> |
| |
| <div>Comma Separated list of Types to exclude when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>excludeTypes</tt></li> |
| </ul><hr /> |
| <p><b><a name="includeArtifactIds">includeArtifactIds</a>:</b></p> |
| |
| <div>Comma separated list of ArtifactIds to include when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>includeArtifactIds</tt></li> |
| </ul><hr /> |
| <p><b><a name="includeClassifiers">includeClassifiers</a>:</b></p> |
| |
| <div>Comma Separated list of Classifiers to include when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>includeClassifiers</tt></li> |
| </ul><hr /> |
| <p><b><a name="includeDependencies">includeDependencies</a>:</b></p> |
| |
| <div>If we should include project dependencies when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>includeDependencies</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /> |
| <p><b><a name="includeGroupIds">includeGroupIds</a>:</b></p> |
| |
| <div>Comma separated list of GroupIds to include when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>includeGroupIds</tt></li> |
| </ul><hr /> |
| <p><b><a name="includeScope">includeScope</a>:</b></p> |
| |
| <div>Scope to include. Empty string indicates all scopes (default).</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>includeScope</tt></li> |
| </ul><hr /> |
| <p><b><a name="includeTypes">includeTypes</a>:</b></p> |
| |
| <div>Comma Separated list of Types to include when indexing.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>includeTypes</tt></li> |
| </ul><hr /> |
| <p><b><a name="outputDirectory">outputDirectory</a>:</b></p> |
| |
| <div>The output directory.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>outputDirectory</tt></li> |
| |
| <li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row span12">Copyright © 2010-2019 |
| <a href="http://www.eclipse.org/">The Eclipse Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| <p id="poweredBy" class="pull-right"> |
| <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> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |