diff --git a/doc/cd-opt.xml b/doc/cd-opt.xml index babadd0..12629d7 100644 --- a/doc/cd-opt.xml +++ b/doc/cd-opt.xml @@ -108,12 +108,12 @@ 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 +
-inferdepinpackage
Enable or 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 +
-inferdepvis
Specifies 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.
@@ -159,7 +159,7 @@ 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
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 UMLGraphDoc, you'll have to generate them diff --git a/doc/cd-umldoc.xml b/doc/cd-umldoc.xml index f5e0144..af9143e 100644 --- a/doc/cd-umldoc.xml +++ b/doc/cd-umldoc.xml @@ -1,12 +1,12 @@ -UMLGraphDoc 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. +UMLGraphDoc is a standard doclet wrapper that combines +the standard doclet output (javadoc documentation) along with auto-generated +class diagrams for both packages and classes. -UMLGraphDoc 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 +The UMLGraphDoc process is driven by all the 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: @@ -41,10 +41,12 @@ UMLGraph javadocs are now generated with UMLGraphDoc with the following ant targ -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 +When generating documentation with UMLGraphDoc you will encounter +at some point the "fur ball" effect: some central classes that +have very complex 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, +If you find that this is not enough and have suggestions on how to improve the situation further, we are eager to listen. diff --git a/doc/index.xml b/doc/index.xml index 445fc24..5ff7263 100644 --- a/doc/index.xml +++ b/doc/index.xml @@ -6,7 +6,7 @@ Class Diagram Operationscd-oper Class Modellingcd-model Class Diagram Optionscd-opt -Javadocs and UML class diagrams with UMLDoccd-umldoc +Javadocs and UML class diagrams with UMLGraphDoccd-umldoc Class Diagram Viewsviews Class Diagram Example: Generalisation Relationshipsceg-gen Class Diagram Example: Advanced Relationshipsceg-adv diff --git a/doc/ver.xml b/doc/ver.xml index 1db99a1..4c29119 100644 --- a/doc/ver.xml +++ b/doc/ver.xml @@ -3,19 +3,22 @@
-
Version 4.4 Under development
+
Version 4.5 Under development
+
    -
  • Major new functionality: UmlDoc, a new doclet that can generate context and package +
    Version 4.4
    +
      +
    • Major new functionality: UmlGraphDoc, a new doclet that can generate context and package class diagrams integrated with the standard javadoc output. Uses the same switches as UmlGraph. (Andrea Aime)
      • -
    • Removed -vebose2 option, use the standard -quiet option instead to avoid UmlDoc and +
    • Removed -verbose2 option, use the standard -quiet option instead to avoid UmlGraphDoc and UmlGraph printing notices. (Andrea Aime)
      • -
    • Added -inferdepvis option, that allows to control which member of a class will be used +
    • Added a -inferdepvis option that allows to control which member of a class will be used for dependency inference. Acceptable values are private, package, protected and public. Makes sense when inferring dependencies without using -useimports.
      • -
    • Added -inferdepinpackage option, that enables dependency inference among classes in the +
    • Added a -inferdepinpackage option that enables dependency inference among classes in the same package. This is disabled by default, since there is no reliable way to infer - them, and classes in the same package are supposed to be related anyway.
      • + dependencies, and classes in the same package are supposed to be related anyway.
    • Support the -link flag in the same way as the standard doclet, in order to populate the api doc map, used to generate image maps with links to associated external classes.