Small grammar and style changes.

This commit is contained in:
Diomidis Spinellis 2006-07-18 20:15:28 +00:00
parent 6c120adba4
commit d180a45fcc
4 changed files with 24 additions and 19 deletions

View File

@ -108,12 +108,12 @@ Defaults to "navassoc" (see the class modelling chapter for a list of relationsh
<dt>-inferdep</dt><dd>Try to automatically infer dependencies between classes by inspecting
methods and fields. See the class diagram inference chapter for more details. Disabled by default.
</dd>
<dt>-inferdepinpackage</dt><dd>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
<dt>-inferdepinpackage</dt><dd>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.
</dd>
<dt>-inferdepvis</dt><dd>Allows to specify the lowest visibility level of elements used to infer
<dt>-inferdepvis</dt><dd>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.
</dd>
@ -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).
</dd>
<dt>-link</dt><dd>A clone of the standard doclet
<dt>-link</dt><dd>A clone of the standard doclet
<a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#link">-link</a>
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

View File

@ -1,12 +1,12 @@
<?xml version="1.0" ?>
<!-- $Id$ -->
<notes>
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
</target>
</fmtcode>
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.
</notes>

View File

@ -6,7 +6,7 @@
<ch><ti>Class Diagram Operations</ti><fi>cd-oper</fi></ch>
<ch><ti>Class Modelling</ti><fi>cd-model</fi></ch>
<ch><ti>Class Diagram Options</ti><fi>cd-opt</fi></ch>
<ch><ti>Javadocs and UML class diagrams with UMLDoc</ti><fi>cd-umldoc</fi></ch>
<ch><ti>Javadocs and UML class diagrams with UMLGraphDoc</ti><fi>cd-umldoc</fi></ch>
<ch><ti>Class Diagram Views</ti><fi>views</fi></ch>
<ch><ti>Class Diagram Example: Generalisation Relationships</ti><fi>ceg-gen</fi></ch>
<ch><ti>Class Diagram Example: Advanced Relationships</ti><fi>ceg-adv</fi></ch>

View File

@ -3,19 +3,22 @@
<notes>
<dl>
<dt>Version 4.4 Under development</dt><dd>
<dt>Version 4.5 Under development</dt><dd></dd>
<ul>
<li>Major new functionality: UmlDoc, a new doclet that can generate context and package
<dt>Version 4.4 </dt><dd>
<ul>
<li>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)</li>
<li>Removed -vebose2 option, use the standard -quiet option instead to avoid UmlDoc and
<li>Removed -verbose2 option, use the standard -quiet option instead to avoid UmlGraphDoc and
UmlGraph printing notices. (Andrea Aime)</li>
<li>Added -inferdepvis option, that allows to control which member of a class will be used
<li>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.</li>
<li>Added -inferdepinpackage option, that enables dependency inference among classes in the
<li>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.</li>
dependencies, and classes in the same package are supposed to be related anyway.</li>
<li>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.
</li>