dahlemd 04/10/22 03:04:47
Modified: dotuml/xdocs Tag: new-dotuml-plugin_01-branch index.xml
Log:
added sequence diagram introduction
Revision Changes Path
No revision
No revision
1.1.2.2 +44 -19 maven-plugins/dotuml/xdocs/Attic/index.xml
Index: index.xml
===================================================================
RCS file: /cvsroot/maven-plugins/maven-plugins/dotuml/xdocs/Attic/index.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- index.xml 3 Oct 2004 15:59:00 -0000 1.1.2.1
+++ index.xml 22 Oct 2004 10:04:46 -0000 1.1.2.2
@@ -18,30 +18,55 @@
The properties that allow you to customize the execution of
this plugin are documented <a href="properties.html">here</a>.
</p>
- <p>
- The following list contains additional JavaDoc tags which are used by the
- <a href="http://www.spinellis.gr/sw/umlgraph/">UmlGraph</a> doclet to
- generate the UML diagrams:
- <ul>
- <li>stereotypes (using the @stereotype name tag)</li>
- <li>tagged values (using the @tagvalue name value tag)</li>
- <li>association relationships (specified using the javadoc @assoc tag)</li>
- <li>navigatable (directed) association relationships (specified using the javadoc @navassoc tag)</li>
- <li>aggregation relationships (specified using the javadoc @has tag)</li>
- <li>composition relationships (specified using the javadoc @composed tag)</li>
- <li>dependency relationships (specified using the javadoc @depend tag)</li>
- </ul>
- </p>
- <p>
- The relationship tags take for arguments:
- <pre>
+ <section name="Class Diagrams">
+ <p>
+ The following list contains additional JavaDoc tags which are used by the
+ <a href="http://www.spinellis.gr/sw/umlgraph/">UmlGraph</a> doclet to
+ generate the UML diagrams:
+ <ul>
+ <li>stereotypes (using the @stereotype name tag)</li>
+ <li>tagged values (using the @tagvalue name value tag)</li>
+ <li>association relationships (specified using the javadoc @assoc tag)</li>
+ <li>navigatable (directed) association relationships (specified using the javadoc @navassoc tag)</li>
+ <li>aggregation relationships (specified using the javadoc @has tag)</li>
+ <li>composition relationships (specified using the javadoc @composed tag)</li>
+ <li>dependency relationships (specified using the javadoc @depend tag)</li>
+ </ul>
+ </p>
+ <p>
+ The relationship tags take for arguments:
+ <pre>
/**
* @composed 1 - 1 BClass
* @composed 1 - 0..* Class
*/
class AClass {}
- </pre>
- </p>
+ </pre>
+ </p>
+ </section>
+ <section name="Sequence Diagrams">
+ <p>
+ For a detailed description of sequence diagrams using pic macros please have a look at the
+ online <a href="http://www.spinellis.gr/sw/umlgraph/doc/seq-intro.html">documentation</a>.
+ </p>
+ <p>
+ Currently, the best way to add the sequence diagrams into the project web-page is to
+ create a new xdoc file which links to the ones in
+ ${maven.dotuml.pic2plot.dest.dir}. Then link this new file into navigation.xml.<br/>
+ <strong>Note: </strong>the sequence.pic file from the UmlGraph distribution has to be
+ somewhere in your project path. The header of the .pic files require a relative/absolute
+ path to the sequence.pic file.
+ </p>
+ <p>
+ In order to include the generation of sequence diagrams in your project web-page add
+ the following preGoal directive into the project's maven.xml file:
+ <pre>
+<preGoal name="site">
+ <attainGoal name="dotuml:sequence" />
+</preGoal>
+ </pre>
+ </p>
+ </section>
</section>
<section name="Requirements">
<p>
|
