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/12 14:58:15 UTC
svn commit: r594144 - in
/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site:
apt/examples/javasrc.apt apt/examples/umldoc.apt apt/index.apt
apt/screenshots.apt site.xml
Author: vsiveton
Date: Mon Nov 12 05:58:14 2007
New Revision: 594144
URL: http://svn.apache.org/viewvc?rev=594144&view=rev
Log:
o updated documentation
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/screenshots.apt (with props)
Modified:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.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/javasrc.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt?rev=594144&r1=594143&r2=594144&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/javasrc.apt Mon Nov 12 05:58:14 2007
@@ -1,5 +1,5 @@
------
- Java JXR Example
+ JXR Java Example
------
Vincent Siveton
------
@@ -26,29 +26,37 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-JXR Example
+JXR Java Example
- Here is a simple JXR example with Java:
+ Here is a simple JXR example using Java:
+-----+
- JavaSrc javaSrc = new JavaSrc( getSrcDir(), getDestDir() );
+ /** Source dir, required. */
+ File srcDir;
+
+ /** Output dir, required. */
+ File destDir;
// 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" );
+ JavaSrcOptions options = new JavaSrcOptions();
+ options.setBottom( "A bottom" );
+ options.setDocencoding( "UTF-8" );
+ options.setDoctitle( "A doctitle" );
+ options.setEncoding( "UTF-8" );
+ options.setFooter( "A footer" );
+ options.setHeader( "An header" );
+ options.setPackagesheader( "A packagesheader" );
+ options.setRecurse( true );
+ options.setStylesheetfile( "path/to/stylesheetfile" );
+ options.setTop( "A top" );
+ options.setVerbose( true );
+ options.setWindowtitle( "A windowtitle" );
+
+ JavaSrc javaSrc = new GenerateHTMLJavaSrc( getSrcDir(), getDestDir() );
+ /* JavaSrc javaSrc = (JavaSrc) lookup( JavaSrc.ROLE ); // Using Plexus */
// generated cross-references HTML files
- javaSrc.pass();
+ javaSrc.generate( srcDir, destDir, options );
+-----+
The following image is an sample of the generated HTML files.
Modified: 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=594144&r1=594143&r2=594144&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/umldoc.apt Mon Nov 12 05:58:14 2007
@@ -28,22 +28,34 @@
UML Java Example
- Here is a simple UML example with Java:
+ Here is a simple UML example using Java:
+-----+
- GenerateUMLDoc generator = new GenerateUMLDoc( getSrcDir(), getOut() );
+ /** Source dir, required. */
+ File srcDir;
+
+ /** Source file encoding name. */
+ String encoding;
+
+ /** Output file of the diagram*/
+ File out;
+
+ /** The class diagram encoding. */
+ String diagramEncoding;
+
+ UMLDoc umlDoc = new GenerateUMLDoc();
+ /* UmlDoc umldoc = (UmlDoc) lookup( UmlDoc.ROLE ); // Using Plexus */
// 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)" );
+ umldoc.setVerbose( true );
+ umldoc.setShow( "protected" );
+
+ umldoc.setJavadocPath( "../apidocs" ); // Javadoc path
+ /* umldoc.setJavasrcPath( "../xref" ); // JXR path */
+ umldoc.setDiagramLabel( "Class Diagram (Generated by Maven on Thu Nov 01 19:17:38 EDT 2007)" );
// Generate
- generator.generateUML();
+ umldoc.generate( srcDir, encoding, out, diagramEncoding );
+-----+
The following image is an sample of the generated HTML files.
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=594144&r1=594143&r2=594144&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 Mon Nov 12 05:58:14 2007
@@ -59,6 +59,6 @@
* {{{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}With Ant}}: {{{http://ant.apache.org/}Ant}} tool examples to use them.
[]
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/screenshots.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/screenshots.apt?rev=594144&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/screenshots.apt (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/screenshots.apt Mon Nov 12 05:58:14 2007
@@ -0,0 +1,33 @@
+ ------
+ 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 Screenshots
+
+[./images/javasrc-sample.png] Javasrc sample
+
+[./images/uml_small.png] UML class diagram sample
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/screenshots.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/screenshots.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
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=594144&r1=594143&r2=594144&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 Mon Nov 12 05:58:14 2007
@@ -72,13 +72,14 @@
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="References" href="references.html"/>
+ <item name="Screenshots" href="screenshots.html"/>
</menu>
<menu name="Examples">
- <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="JXR With Java" href="/examples/javasrc.html"/>
+ <item name="UML with Java" href="/examples/umldoc.html"/>
<item name="Using XML doclet" href="/examples/xmldoclet.html"/>
+ <item name="With Ant" href="/examples/ant.html"/>
</menu>
<menu ref="reports"/>