Documentation for UMLDoc and new options? Ready to release?

doc/cd-opt.xml

@@ -108,6 +108,15 @@ 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
+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 
+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>
 <dt>-useimports</dt><dd>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).
 </dd>
+<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 UMLDoc, you'll have to generate them
+manually with graphviz if using UMLGraph).
+</dd>
 </dl>
 <p />
 All colors can be either a symbolic name (e.g. blue),

doc/cd-umldoc.xml

@@ -0,0 +1,50 @@
+<?xml version="1.0" ?>
+<!-- $Id$ -->
+<notes>
+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:
+<ul>
+<li>for packages, the diagram contains all of the classes in the package itself</li>
+<li>for classes, the set of classes somehow related to the current class</li>
+</ul>
+
+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:
+
+<fmtcode ext="xml">
+<target name="javadocs" depends="compile">
+	<javadoc sourcepath="${src}" packagenames="gr.spinellis.umlgraph.doclet.*" destdir="${javadoc}" 
+	         private="true">
+		<doclet name="gr.spinellis.umlgraph.doclet.UmlDoc" path="${lib}/UMLGraph.jar">
+			<param name="-inferrel"/>
+			<param name="-inferdep"/>
+			<param name="-hide" value="java.*"/>
+			<param name="-collpackages" value="java.util.*"/>
+			<param name="-qualify"/>
+			<param name="-postfixpackage"/>
+			<param name="-nodefontsize" value="9"/>
+			<param name="-nodefontpackagesize" value="7"/>
+			<param name="-link" value="http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/doclet/spec"/>
+			<param name="-link" value="http://java.sun.com/j2se/1.5/docs/api"/>
+		</doclet>
+	</javadoc>
+</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
+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.
+</notes>

doc/index.xml

@@ -6,6 +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>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>