commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r889255 - /commons/proper/jelly/branches/MAVEN-2-BRANCH/build-tagdoc.xml
Date Thu, 10 Dec 2009 13:24:40 GMT
Author: niallp
Date: Thu Dec 10 13:24:40 2009
New Revision: 889255

URL: http://svn.apache.org/viewvc?rev=889255&view=rev
Log:
Add comments about generating the Jelly Tag documentation

Modified:
    commons/proper/jelly/branches/MAVEN-2-BRANCH/build-tagdoc.xml

Modified: commons/proper/jelly/branches/MAVEN-2-BRANCH/build-tagdoc.xml
URL: http://svn.apache.org/viewvc/commons/proper/jelly/branches/MAVEN-2-BRANCH/build-tagdoc.xml?rev=889255&r1=889254&r2=889255&view=diff
==============================================================================
--- commons/proper/jelly/branches/MAVEN-2-BRANCH/build-tagdoc.xml (original)
+++ commons/proper/jelly/branches/MAVEN-2-BRANCH/build-tagdoc.xml Thu Dec 10 13:24:40 2009
@@ -14,6 +14,46 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 -->
+<!--
+   Generate Jelly Tag Documentation
+   ================================
+
+   This ant build file is the second part of the process to generate
+   the Jelly Tag documentation.
+
+   The old Maven 1.x build used the maven-jellydoc-plugin to generate the
+   Jelly Tag documentation:
+
+   http://maven.apache.org/maven-1.x/plugins/jellydoc/
+
+   The components of that plugin have been used to provide a
+   mechanism to be continue to generate that documentation
+   with a Maven 2 build for Commons Jelly.
+
+   1) Generate Tag XML using jellydoc Doclet
+   -----------------------------------------
+   The first step in (re-)generating the taglib documentation is
+   to run the JavaDoc Doclet from the maven-jellydoc-plugin
+   which can be done using "doclet" profile in Jelly's parent
+   pom as follows:
+
+       mvn -Pdoclet generate-sources
+
+   This generates a "taglib.xml" file in the "target" folder of
+   each module containing tags.
+
+   2) Generate Tag XDOCS using Jelly script
+   ----------------------------------------
+   The second step is to use Jelly to convert the generated "taglib.xml"
+   files into XDOCS using a Jelly script (copied from maven-jellydoc-plugin).
+
+   This ant build file does that and can be run using the following command:
+
+       ant -f build-tagdoc.xml
+
+   (note: Jelly and its dependencies are automatically downloaded)
+
+-->
 <project name="Jelly Tag XDOC Generation" default="generate-xdoc" basedir=".">
   
   <property name="download.repo"           value="http://repo1.maven.org/maven2"/>



Mime
View raw message