You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2007/11/02 00:55:41 UTC
svn commit: r591169 - in
/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site: ./ apt/
apt/examples/ resources/images/
Author: vsiveton
Date: Thu Nov 1 16:55:38 2007
New Revision: 591169
URL: http://svn.apache.org/viewvc?rev=591169&view=rev
Log:
o updated/added documentation
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/xmldoclet.apt (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/references.apt (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/javasrc-sample.png (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml.png (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml_small.png (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/xmldoclet.png (with props)
Modified:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/index.apt
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/site.xml
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt?rev=591169&r1=591168&r2=591169&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt Thu Nov 1 16:55:38 2007
@@ -1,5 +1,5 @@
------
- Ant Example
+ Ant Examples
------
Vincent Siveton
------
@@ -26,9 +26,9 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Ant Example
+Ant Examples
- Here is a simple Ant example:
+ Here are simple Ant examples:
+-----+
<project name="your-project" basedir=".">
@@ -42,13 +42,24 @@
</fileset>
</path>
- <target name="antdoc">
+ <!-- Generated Java cross-reference HTML files -->
+ <target name="jxr">
<taskdef name="javasrc"
classname="org.apache.maven.jxr.java.src.JavaSrcTask"
classpathref="task.classpath"/>
<javasrc srcDir="${basedir}/src/main/java"
- destDir="${basedir}/target/javasrc" />
+ destDir="${basedir}/target/javasrc" />
+ </target>
+
+ <!-- Generated class diagram -->
+ <target name="uml">
+ <taskdef name="uml"
+ classname="org.apache.maven.jxr.java.src.UmlDocTask"
+ classpathref="task.classpath"/>
+
+ <javasrc srcDir="${basedir}/src/main/java"
+ out="${basedir}/target/uml.png" />
</target>
</project>
+-----+
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt?rev=591169&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt Thu Nov 1 16:55:38 2007
@@ -0,0 +1,57 @@
+ ------
+ Java JXR 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
+
+JXR Example
+
+ Here is a simple JXR example with Java:
+
++-----+
+ JavaSrc javaSrc = new JavaSrc( getSrcDir(), getDestDir() );
+
+ // specify some options
+ javaSrc.getOptions().setBottom( "A bottom" );
+ javaSrc.getOptions().setDocencoding( "UTF-8" );
+ javaSrc.getOptions().setDoctitle( "A doctitle" );
+ javaSrc.getOptions().setEncoding( "UTF-8" );
+ javaSrc.getOptions().setFooter( "A footer" );
+ javaSrc.getOptions().setHeader( "An header" );
+ javaSrc.getOptions().setPackagesheader( "A packagesheader" );
+ javaSrc.getOptions().setRecurse( true );
+ javaSrc.getOptions().setStylesheetfile( "path/to/stylesheetfile" );
+ javaSrc.getOptions().setTop( "A top" );
+ javaSrc.getOptions().setVerbose( true );
+ javaSrc.getOptions().setWindowtitle( "A windowtitle" );
+
+ // generated cross-references HTML files
+ javaSrc.pass();
++-----+
+
+ The following image is an sample of the generated HTML files.
+
+[../images/javasrc-sample.png] JXR sample
+
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt?rev=591169&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt Thu Nov 1 16:55:38 2007
@@ -0,0 +1,55 @@
+ ------
+ UML 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
+
+UML Java Example
+
+ Here is a simple UML example with Java:
+
++-----+
+ GenerateUMLDoc generator = new GenerateUMLDoc( getSrcDir(), getOut() );
+
+ // specify some options
+ generator.setEncoding( "UTF-8" );
+ generator.setVerbose( true );
+ generator.setShow( "protected" );
+ generator.setJavadocPath( "../apidocs" );
+ generator.setJavasrcPath( "../xref" );
+ generator.setDiagramEncoding( "UTF-8" );
+ generator.setDiagramLabel( "Class Diagram (Generated by Maven on Thu Nov 01 19:17:38 EDT 2007)" );
+
+ // Generate
+ generator.generateUML();
++-----+
+
+ The following image is an sample of the generated HTML files.
+
+[../images/uml_small.png] UML sample
+
+ The full size generated image is {{{../images/uml.png}here}}.
+
+ <<IMPORTANT NOTE: YOU NEED TO HAVE {{{http://www.graphviz.org/}Graphviz}} IN YOUR PATH!>>
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/xmldoclet.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/xmldoclet.apt?rev=591169&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/xmldoclet.apt (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/xmldoclet.apt Thu Nov 1 16:55:38 2007
@@ -0,0 +1,43 @@
+ ------
+ XML Javadoc Doclet 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
+
+XML Javadoc Doclet Example
+
+ Here is a simple XML Doclet example for javadoc:
+
++-----+
+ javadoc.exe (or .sh) \
+ <-xmlencoding ISO-8859-1> \
+ -o /path/to/generatedXmlFile -doclet org.apache.maven.jxr.java.doc.XMLDoclet \
+ ...
++-----+
+
+ The following image is an sample of the generated XML file.
+
+[../images/xmldoclet.png] XML doclet sample
+
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/xmldoclet.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/xmldoclet.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/index.apt?rev=591169&r1=591168&r2=591169&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/index.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/index.apt Thu Nov 1 16:55:38 2007
@@ -28,7 +28,15 @@
Maven JXR Java
- This project is a Java code documentation system.
+ This project is a Java code documentation system. It provides:
+
+ * Java cross-reference HTML tool: converting Java source code to HTML with syntax highlighting and cross-reference information
+
+ * XML Javadoc doclet: generating an XML file of the Java source code
+
+ * UML documentation: generating an UML class diagram of the Java source code with the well known {{{http://www.graphviz.org/}Graphviz}} tool
+
+ []
* Brief History
@@ -43,11 +51,14 @@
See the {{{http://www.nabble.com/-Proposal--decide-the-future-of-forrestdoc-tf4060050.html}Forrest thread}} and the
{{{http://www.nabble.com/Forrestdoc-and-Maven-JXR-tf3864888s177.html}Maven thread}}.
-* References
+* Examples
- * Stanchfield, S., and Parr, T. {{{SeriesPt4.pdf}Parsers, Part IV: A Java Cross-Reference Tool}}. December 1997.
- Original files {{{SeriesPt4-xref.zip}here}}.
+ * {{{examples/javasrc.html}JXR}}: Java examples to generate Java cross-reference HTML files.
-* Examples
+ * {{{examples/xmldoclet.html}XmlDoclet}}: {{{http://java.sun.com/j2se/javadoc/}Javadoc}} examples to use the Xml Javadoc Doclet.
+
+ * {{{examples/umldoc.html}UMLDoc}}: Java examples to generate UML class diagram.
+
+ * {{{examples/ant.html}Ant}}: {{{http://ant.apache.org/}Ant}} tool examples to use them.
- * {{{examples/ant.html}Ant}}: Ant example.
+ []
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/references.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/references.apt?rev=591169&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/references.apt (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/references.apt Thu Nov 1 16:55:38 2007
@@ -0,0 +1,37 @@
+ ------
+ Further Links
+ ------
+ Vincent Siveton
+ ------
+ October 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
+
+
+Further References
+
+* Articles
+
+ * {{{http://java.sun.com/developer/technicalArticles/J2SE/xref/}Cross-Referencing HTML the Tiger Way}}
+
+ * Stanchfield, S., and Parr, T. {{{SeriesPt4.pdf}Parsers, Part IV: A Java Cross-Reference Tool}}. December 1997.
+ Original files {{{SeriesPt4-xref.zip}here}}.
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/references.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/references.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/javasrc-sample.png
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/javasrc-sample.png?rev=591169&view=auto
==============================================================================
Binary file - no diff available.
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/javasrc-sample.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml.png
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml.png?rev=591169&view=auto
==============================================================================
Binary file - no diff available.
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml_small.png
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml_small.png?rev=591169&view=auto
==============================================================================
Binary file - no diff available.
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/uml_small.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/xmldoclet.png
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/xmldoclet.png?rev=591169&view=auto
==============================================================================
Binary file - no diff available.
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/resources/images/xmldoclet.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/site.xml?rev=591169&r1=591168&r2=591169&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/site.xml (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/site.xml Thu Nov 1 16:55:38 2007
@@ -71,10 +71,14 @@
<menu name="Overview">
<item name="Introduction" href="index.html"/>
+ <item name="References" href="references.html"/>
</menu>
<menu name="Examples">
- <item name="Using Maven JXR Ant with Ant" href="/examples/ant.html"/>
+ <item name="Using Maven JXR with Ant" href="/examples/ant.html"/>
+ <item name="Using Maven JXR with Java" href="/examples/javasrc.html"/>
+ <item name="Using Maven UML with Java" href="/examples/umldoc.html"/>
+ <item name="Using XML doclet" href="/examples/xmldoclet.html"/>
</menu>
<menu ref="reports"/>