Have you checked whether your system meets the requirements?
If not, you might yet take a look here
before proceeding!
Download and installation instructions
- Download and extract the
class2uml ZIP-file:
class2uml.zip.
- If you want to take a look at the JAVADOC documentation
of the project, do the same to class2uml-doc.zip.
- Append the directory you performed step 2 in to your
CLASSPATH environment variable. For the
Bash shell, that would be:
export CLASSPATH=$CLASSPATH:`pwd`
Inside the project's ZIP archive, you will find the compiled
(.class) files as well as the sources, which you may examine
and/or modify according to the GNU General Public License (GPL).
Brief user's manual
This is really no more than an overview of the command line options
of class2uml. For a first time introduction
to the program, check out the tutorial page!
class2uml is organised in a package carrying the
same name, where ClassDiagram is the main class.
Thus, to execute the program, call
java class2uml.ClassDiagram [options] class_to_analyse
class_to_analyse must be a class name in the fully qualified
package notation (such as class2uml.Test) and
[options] can be a combination of:
-v |
--> |
Produce more textual output, mainly for debugging purposes. |
-o |
--> |
Name of the Dia output file
(default: export.dia). |
-x |
--> |
Name of the XMI output file
(default: export.xmi). |
-ns |
--> |
No Swing window output. |
-nd |
--> |
No Dia output. |
-nx |
--> |
No XMI output. |
-d string |
--> |
Amount of detail to show in the diagram. string
can be a combination of 'g','a','d' which stand for
'generalisations', 'associations' and 'dependencies'.
Default is 'gad' which will visualise all three relationships. |
-a prefix |
--> |
Package prefix of classes that are to be
analysed - all other classes will be built
as empty references. Use this if you want
to restrict the analysis to a certain package
path and to keep your diagrams from exploding. |
-i prefix |
--> |
The sheer opposite of the '-a' option.
Classes bearing the given package prefix
will be ignored, all others analysed. You
might want to e.g. ignore the java. prefix. |
-l n |
--> |
Restrict recursive analysis to level n. Classes at
level (n+1) will just be empty class boxes bearing the stereotype
<<reference>>. Default is '0',
which will restrict the analysis to the given class. |
See also the examples in the about section
for the effects of those optional parameters.