Author: vsiveton
Date: Mon Nov 12 05:40:05 2007
New Revision: 594121
URL: http://svn.apache.org/viewvc?rev=594121&view=rev
Log:
o updated documentation
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/examples/antdoc.apt
(with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/screenshots.apt
(with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_dot.png
(with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_html.png
(with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_tg.png
(with props)
Modified:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/index.apt
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/site.xml
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/examples/antdoc.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/examples/antdoc.apt?rev=594121&view=auto
==============================================================================
---
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/examples/antdoc.apt
(added)
+++
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/examples/antdoc.apt
Mon Nov 12 05:40:05 2007
@@ -0,0 +1,47 @@
+ ------
+ Antdoc Java Example
+ ------
+ Vincent Siveton
+ ------
+ November 2007
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Antdoc Java Example
+
+ Here is a simple Antdoc example using Java:
+
++-----+
+ /** An ant file */
+ File antFile;
+
+ /** Destination directory */
+ File destDir;
+
+ AntDoc antdoc = new GenerateHTMLDoc();
+ /* AntDoc antdoc = (AntDoc) lookup( AntDoc.ROLE ); // Using Plexus */
+
+ antdoc.generate( antFile, destDir );
++-----+
+
+ <<IMPORTANT NOTE: YOU NEED TO HAVE {{{http://www.graphviz.org/}Graphviz}} IN
YOUR PATH!>>
+
Propchange:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/examples/antdoc.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/examples/antdoc.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/index.apt?rev=594121&r1=594120&r2=594121&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/index.apt
(original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/index.apt Mon
Nov 12 05:40:05 2007
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- October 2007
+ November 2007
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,7 +28,13 @@
Maven JXR Ant
- This project is an Ant code documentation system.
+ This project is an {{{http://ant.apache.org/}Ant}} code documentation system.
It generates:
+
+ * Ant graph: generating an graph of the Ant source code with the well known
{{{http://www.graphviz.org/}Graphviz}} tool
+
+ * Ant HTML: generating an HTML documentation of the Ant source code
+
+ []
* Brief History
@@ -44,4 +50,8 @@
* Examples
- * {{{examples/ant.html}Ant}}: Some Ant example.
+ * {{{examples/ant.html}Using Ant}}: {{{http://ant.apache.org/}Ant}} tool
examples to use them.
+
+ * {{{examples/antdoc.html}Using Java}}: Java examples to generate Ant
documentation.
+
+ []
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/screenshots.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/screenshots.apt?rev=594121&view=auto
==============================================================================
---
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/screenshots.apt
(added)
+++
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/screenshots.apt
Mon Nov 12 05:40:05 2007
@@ -0,0 +1,35 @@
+ ------
+ Screenshots
+ ------
+ Vincent Siveton
+ ------
+ November 2007
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Maven JXR Ant Screenshots
+
+[./images/antdoc_dot.png] Sample Ant graph as image
+
+[./images/antdoc_tg.png] Sample Ant graph using Touchgraph
+
+[./images/antdoc_html.png] Sample Ant HTML documentation
Propchange:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/screenshots.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/apt/screenshots.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_dot.png
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_dot.png?rev=594121&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_dot.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_html.png
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_html.png?rev=594121&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_html.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_tg.png
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_tg.png?rev=594121&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/resources/images/antdoc_tg.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/site.xml?rev=594121&r1=594120&r2=594121&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/site.xml (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-ant/src/site/site.xml Mon Nov
12 05:40:05 2007
@@ -71,10 +71,12 @@
<menu name="Overview">
<item name="Introduction" href="index.html"/>
+ <item name="Screenshots" href="screenshots.html"/>
</menu>
<menu name="Examples">
- <item name="Using Maven JXR Ant with Ant" href="/examples/ant.html"/>
+ <item name="With Ant" href="/examples/ant.html"/>
+ <item name="With Java" href="/examples/antdoc.html"/>
</menu>
<menu ref="reports"/>
