From e8fcbbf72c36158dff823d1b6f22de76a6c556c9 Mon Sep 17 00:00:00 2001 From: Diomidis Spinellis Date: Tue, 17 Apr 2012 08:13:23 +0000 Subject: [PATCH] Improvements after reviewing --- doc/catalina.java | 6 ++++++ doc/cd-intro.xml | 2 +- doc/cd-model.xml | 2 +- doc/cd-oper.xml | 12 ++++++------ doc/classadd.java | 12 ++++++------ doc/color.java | 3 ++- doc/index.xml | 2 +- doc/intro.xml | 5 +++-- doc/note.java | 7 +++++++ 9 files changed, 33 insertions(+), 18 deletions(-) diff --git a/doc/catalina.java b/doc/catalina.java index 500c164..05f4962 100644 --- a/doc/catalina.java +++ b/doc/catalina.java @@ -3,6 +3,12 @@ * $Id$ */ +/** + * @opt nodefontname "Arial" + * @hidden + */ +class UMLOptions{} + class HttpResponseBase extends ResponseBase implements HttpResponse, HttpServletResponse {} diff --git a/doc/cd-intro.xml b/doc/cd-intro.xml index 0de52a6..713a4c8 100644 --- a/doc/cd-intro.xml +++ b/doc/cd-intro.xml @@ -8,7 +8,7 @@ Running the UmlGraph doclet on the specification will generate a Graphviz diagram specification that can be automatically processed to -create Postscript, GIF, SVG, JPEG, fig, or Framemaker drawings. +create PNG, SVG, EMF, Postscript, GIF, JPEG, fig, or Framemaker drawings.

The following is an example of a specification and the resulting UML class diagram: diff --git a/doc/cd-model.xml b/doc/cd-model.xml index 1214546..a44a41e 100644 --- a/doc/cd-model.xml +++ b/doc/cd-model.xml @@ -33,7 +33,7 @@ collaborations, and packages

  • dependency relationships (specified using the javadoc @depend tag)
    • -All relationship tags appart from @extends take four arguments: +All relationship tags apart from @extends take four arguments:
    1. The source adornments (role, multiplicity, and visibility)
      2. diff --git a/doc/cd-oper.xml b/doc/cd-oper.xml index 0d830f7..b5ad539 100644 --- a/doc/cd-oper.xml +++ b/doc/cd-oper.xml @@ -16,20 +16,20 @@ Java code. Note however that UMLGraph was not originally designed for this purpose; the resulting graphs may be large and unwieldy.

      -There are various ways to invoke UmlGraph, +There are various ways to invoke UMLGraph, each providing a different balance between convenience and flexibility.

      Option 1: Using the Supplied Script

      This is the simplest option. If umlgraph (or umlgraph.bat) is correctly installed, -you can run UmlGraph by simply specifying the basename of +you can run UMLGraph by simply specifying the basename of the Java file containing the diagram specification and the file type of the generated diagram (e.g. gif, ps, png, svg). Example: umlgraph Test png -Any additional UmlGraph or javadoc arguments can be added at +Any additional UMLGraph or javadoc arguments can be added at the end of the command line. This command will read the specification file (e.g. Test.java) and generate directly a diagram of the appropriate type @@ -41,7 +41,7 @@ You can accomplish this in two ways.
      1. Specify the location of tools.jar as a part of Java's classpath -and specify the full name of the UmlGraph doclet as an argument to Java. +and specify the full name of the UMLGraph doclet as an argument to Java. This is an invocation example under Windows java -classpath "lib/UmlGraph.jar;c:\program files\java\jdk1.6.0_02\lib\Tools.jar" @@ -58,7 +58,7 @@ file in a directory that also contains the Java SDK tools.jar file. You can accomplish this either by copying UmlGraph.jar to the SDK lib directory where tools.jar resides, or by copying the JDK tools.jar file into the directory -where you installed UmlGraph. +where you installed UMLGraph. You then run java -jar /path/to/UmlGraph.jar yourfile1.java ... @@ -76,7 +76,7 @@ java -jar /usr/jvm/java-1.5.0/lib/UmlGraph.jar -private Simple.java Specifying some packages before the list of source files will designate those packages as local. When you specify a package list, -the SVG output UmlGraph generates will contain +the SVG output UMLgraph generates will contain local hyperlinks for the local classes and hyperlinks to the Sun Java API documentation for all other classes.

        diff --git a/doc/classadd.java b/doc/classadd.java index 45b650c..2567ef9 100644 --- a/doc/classadd.java +++ b/doc/classadd.java @@ -4,10 +4,10 @@ * $Id$ */ -/** - * @opt attributes - * @opt operations - * @opt types +/** + * @opt attributes + * @opt operations + * @opt types * @hidden */ class UMLOptions {} @@ -15,8 +15,8 @@ class UMLOptions {} /** @hidden */ class Action {} -/** - * @stereotype container +/** + * @stereotype container * @tagvalue version 3.2 */ class ActionQueue { diff --git a/doc/color.java b/doc/color.java index f4a82aa..9977814 100644 --- a/doc/color.java +++ b/doc/color.java @@ -11,12 +11,13 @@ class UMLOptions{} /** - * @opt nodefontname "Helvetica-Bold" + * @opt nodefontname "Arial" * @opt nodefontcolor "white" * @composed - - - Red * @composed - - - Green * @composed - - - Blue * @opt attributes + * @opt operations * @opt visibility * @opt types */ diff --git a/doc/index.xml b/doc/index.xml index c71a8ed..9d9da66 100644 --- a/doc/index.xml +++ b/doc/index.xml @@ -23,7 +23,7 @@ Class Diagram Example: Class Stereotypes and Tagged Valuesceg-ster Class Diagram Example: Fonts, Colors, Global and Local Optionsceg-color Class Diagram Example: Multiple Views Through Command-Line Optionsceg-mv -Class Diagram Example: Inner support for viewsceg-view-spec +Class Diagram Example: Built-in Support for Viewsceg-view-spec Class Diagram Example: Views With Different Specification Detailsceg-view-details Class Diagram Example: Views for Different Packagesceg-view-packages Running the Doclet from Antant diff --git a/doc/intro.xml b/doc/intro.xml index 4bffeb4..b5ec4de 100644 --- a/doc/intro.xml +++ b/doc/intro.xml @@ -34,8 +34,9 @@ Creating models in a declarative, textual notation offers a number of advantages It is more difficult for designers to get away, as they often do now, with drawing for a model a nice picture of the implementation they have in mind.

      2. The declarative representation is also highly malleable, the existing visual structure does not hinder drastic changes, nor is effort wasted on the tidy arrangement of graph nodes a psychological barrier against massive design refactoring.
      3. Declarative models are also highly automatable: they can be easily generated from even higher-level descriptions by trivial scripts and tools operating on design process inputs such as database schemas, existing code, or structured requirements documents.
        4. -
      4. Text macro processors can be used for configuration management, while revision control and team integration activities can utilize the same proven tools and processes that are currently used for managing source code. - Thus with a tool like CVS or RCS one can keep track of design revisions, create and merge branches, and monitor model changes, while a system like CVS can allow work to be split into teams.
        5. +
      5. With a declarative specification under the programmer's control a macro processors can be used for configuration management, allowing the same model to be used for generating diverse diagrams.
        6. +
      6. Revision control and team integration activities can utilize the same proven tools and processes that are currently used for managing source code. + Thus with a tool like Subversion or Git one can keep track of design revisions, create and merge branches, monitor model changes, and split work among a team.
      7. Finally, the declarative approach can readily utilize existing text processing tools for tasks that a drawing editor system may not provide.
        8. Consider how your favorite model editor handles the following tasks and how you could handle them using a simple Perl script or a text-processing pipeline applied to the declarative model specification: diff --git a/doc/note.java b/doc/note.java index 1c5944f..3f4d498 100644 --- a/doc/note.java +++ b/doc/note.java @@ -1,3 +1,10 @@ +/** + * @opt nodefontname "Helvetica" + * @opt edgefontname "Helvetica" + * @hidden + */ +class UMLOptions{} + /** * @opt shape node * @note Located in the