From 79f73a06d2b1b5f0d8962ffcbb4ca406b6ca09aa Mon Sep 17 00:00:00 2001 From: Andrea Aime Date: Sun, 9 Jul 2006 15:15:43 +0000 Subject: [PATCH] Documentation for UMLDoc and new options? Ready to release? --- doc/cd-opt.xml | 15 ++++++++++++++ doc/cd-umldoc.xml | 50 +++++++++++++++++++++++++++++++++++++++++++++++ doc/index.xml | 1 + 3 files changed, 66 insertions(+) create mode 100644 doc/cd-umldoc.xml diff --git a/doc/cd-opt.xml b/doc/cd-opt.xml index 04fe6f5..f7f6059 100644 --- a/doc/cd-opt.xml +++ b/doc/cd-opt.xml @@ -108,6 +108,15 @@ Defaults to "navassoc" (see the class modelling chapter for a list of relationsh
-inferdep
Try to automatically infer dependencies between classes by inspecting methods and fields. See the class diagram inference chapter for more details. Disabled by default.
+
-inferdepinpackage
Allows to enable/disable dependency inference among classes in the +same package. This option is disabled by default because classes in the same package are supposed +to be related anyway, and also because there's no working mechanism to actually detect all +of these dependencies since imports are not required to use classes in the same package. +
+
-inferdepvis
Allows to specify the lowest visibility level of elements used to infer +dependencies among classes. Possible values are private, package, protected, public, in this +order. The default value is private. Use higher levels to limit the number of inferred dependencies. +
-useimports
Will also use imports to infer dependencies. Disabled by default, since it does not work properly if there are multiple classes in the same source file (will add dependencies to every class in @@ -150,6 +159,12 @@ in a single line instead of "pretty printing" them. Useful if the dot file has to be manipulated by an automated tool (e.g., the UMLGraph regression test suite).
+
-link
A clone of the standard doclet +-link +option, allows UMLGraph to generate links from class symbols to their external javadoc +documentation (image maps are automatically generated in UMLDoc, you'll have to generate them +manually with graphviz if using UMLGraph). +

All colors can be either a symbolic name (e.g. blue), diff --git a/doc/cd-umldoc.xml b/doc/cd-umldoc.xml new file mode 100644 index 0000000..e1f1819 --- /dev/null +++ b/doc/cd-umldoc.xml @@ -0,0 +1,50 @@ + + + +UMLDoc is a standard doclet wrapper that allows for mixing togher +the standard doclet output (javadoc documentation) along with self-generated +class diagrams for both package and classes. + +UMLDoc can be driven by the sum of parameters that can be specified for +UMLGraph and the standard doclet, each will be passed to the appropriate +doclet. + +Diagram generation is based on the idea of context: +

+ +The actual content of the diagrams depends on the kind of relations declared on the +class files (with the UMLGraph javadoc annotations) and/or on the kind of automated +inference that UMLGraph is allowed to use. + +UMLGraph javadocs are now generated with UMLDoc with the following ant target: + + + + + + + + + + + + + + + + + + + + +Some users did complain about the "furr ball" effect, that is, the problem that some central +classes do have very big context diagrams. To reduce this, you can avoid dependency inference +altogheter, or reduce the number of inferred dependencies by using the -inferdepvis options. + +If you find that this is not enough and have suggestions on how to improve further it, +we are eager to listen. + diff --git a/doc/index.xml b/doc/index.xml index 83fabde..445fc24 100644 --- a/doc/index.xml +++ b/doc/index.xml @@ -6,6 +6,7 @@ Class Diagram Operationscd-oper Class Modellingcd-model Class Diagram Optionscd-opt +Javadocs and UML class diagrams with UMLDoccd-umldoc Class Diagram Viewsviews Class Diagram Example: Generalisation Relationshipsceg-gen Class Diagram Example: Advanced Relationshipsceg-adv