You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2008/07/17 22:30:05 UTC

svn commit: r677710 - in /maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site: apt/reference.apt site.xml

Author: dennisl
Date: Thu Jul 17 13:30:05 2008
New Revision: 677710

URL: http://svn.apache.org/viewvc?rev=677710&view=rev
Log:
[MANTTASKS-114] Improve documentation

o Add reference documentation for VersionMapper.

Modified:
    maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt   (contents, props changed)
    maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/site.xml

Modified: maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt
URL: http://svn.apache.org/viewvc/maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt?rev=677710&r1=677709&r2=677710&view=diff
==============================================================================
--- maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt (original)
+++ maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt Thu Jul 17 13:30:05 2008
@@ -1,5 +1,5 @@
  ------
- Task Reference
+ Task and Type Reference
  ------
  Brett Porter
  Herve Boutemy
@@ -156,6 +156,7 @@
 | <<<version>>>    | The version of the provider to install. <Required>
 *------------------+--------------------------------------------------------------------------+
 
+
 Type Reference
 
 * <<<localRepository>>>
@@ -218,4 +219,16 @@
 | <<<id>>>         | The reference ID of this POM.
 *------------------+--------------------------------------------------------+
 
-  ~~ TODO: Add reference documentation for VersionMapper
+* <<<{VersionMapper}>>>
+
+  This is a {{{http://ant.apache.org/manual/CoreTypes/mapper.html}filename mapper}}
+  that removes version info from the filename when copying dependencies. It can
+  also, optionally, remove the directory info from the filename.
+
+*------------------+--------------------------------------------------------+--------------+
+| <<Attribute>>    | <<Description>>                                        | <<Required>>
+*------------------+--------------------------------------------------------+--------------+
+| <<<from>>>       | The original filename.                                 | Yes
+*------------------+--------------------------------------------------------+--------------+
+| <<<to>>>         | If this is set to <<<flatten>>> the directory info is also removed from the filename. | No
+*------------------+--------------------------------------------------------+--------------+

Propchange: maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/apt/reference.apt
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author Id

Modified: maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/site.xml?rev=677710&r1=677709&r2=677710&view=diff
==============================================================================
--- maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/site.xml (original)
+++ maven/ant-tasks/branches/maven-ant-tasks-2.0.x/src/site/site.xml Thu Jul 17 13:30:05 2008
@@ -32,7 +32,7 @@
       <item name="Introduction" href="index.html"/>
       <item name="Installation" href="installation.html"/>
       <item name="Usage" href="usage.html"/>
-      <item name="Task Reference" href="reference.html"/>
+      <item name="Task and Type Reference" href="reference.html"/>
       <item name="Release Notes" href="release-notes.html"/>
     </menu>