Add the ability to generate a skeletal doc on the taglib(s) provided by plugins

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115847 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
dion committed 2004-07-18 14:20:03 +00:00
1 parent 3e9261d709
commit a7c9c04173
9 files changed
+1237 -1

No files matched your search

+1
View File
@@ -27,6 +27,7 @@
<menu name="Overview">
<item href="/goals.html" name="Goals"/>
<item href="/properties.html" name="Properties"/>
<item href="/tags.html" name="Tags"/>
</menu>
</body>
</project>
+113
View File
@@ -0,0 +1,113 @@
<document>
<properties>
<title>Plugin tags</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name='Overview'>
<p>The following tag libraries and tags are provided by this plugin.</p>
<ol>
<li><a href='#plugin_Tag_Library'>plugin</a>
<ol>
<li><a href='#uninstall_Tag'>uninstall</a></li>
<li><a href='#clearCache_Tag'>clearCache</a></li>
</ol>
</li>
<li><a href='#assert_Tag_Library'>assert</a>
<ol>
<li><a href='#assertFileExists_Tag'>assertFileExists</a></li>
<li><a href='#assertFileNotFound_Tag'>assertFileNotFound</a></li>
<li><a href='#assertEquals_Tag'>assertEquals</a></li>
</ol>
</li>
</ol>
</section>
<section name='plugin Tag Library'>
<subsection name='uninstall Tag'>
<p>
A tag to uninstall a given plugin from the various plugin directories, including
<ol>
<li><code>${maven.plugin.dir}</code></li>
<li><code>${maven.plugin.user.dir}</code></li>
<li><code>${maven.plugin.unpacked.dir}</code></li>
</ol>
</p>
<table>
<tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>name</td>
<td>No</td>
<td>Usually this is <code>${pom.artifactId}</code></td>
</tr>
</table>
</subsection>
<subsection name='clearCache Tag'>
<p>
Clears the files used for caching plugin goals, dependencies and
tag libraries from <code>${maven.plugin.unpacked.dir}</code>
</p>
<p>There are no attributes for this tag</p>
</subsection>
</section>
<section name='assert Tag Library'>
<p>
This tag library is typically used in testing plugins. And are
similar in usage to the assert methods in a JUnit test case.
</p>
<subsection name='assertFileExists Tag'>
<p>Fails the build if the given file does not exist, otherwise no effect.</p>
<table>
<tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>file</td>
<td>No</td>
<td>The path of the file to be checked</td>
</tr>
<tr>
<td>msg</td>
<td>Yes</td>
<td>A message to be displayed when the file doesn't exist</td>
</tr>
</table>
</subsection>
<subsection name='assertFileNotFound Tag'>
<p>Fails the build if the given file does exist, otherwise no effect.</p>
<table>
<tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>file</td>
<td>No</td>
<td>The path of the file to be checked</td>
</tr>
<tr>
<td>msg</td>
<td>Yes</td>
<td>A message to be displayed when the file doesn't exist</td>
</tr>
</table>
</subsection>
<subsection name='assertEquals Tag'>
<p>Fails the build if the two values are not equal, otherwise no effect.</p>
<table>
<tr><th>Attribute</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>expected</td>
<td>No</td>
<td>The expected value</td>
</tr>
<tr>
<td>value</td>
<td>No</td>
<td>The actual value</td>
</tr>
<tr>
<td>msg</td>
<td>Yes</td>
<td>A message to be displayed when the values aren't equal.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>