Go to file
Diomidis Spinellis 8d7a3e4b5c [maven-release-plugin] prepare release R6_0_0 2023-05-23 14:59:31 +03:00
doc Add -hideprivateinner option 2018-11-03 23:06:36 +01:00
legacy Legacy file reorganization 2012-04-25 13:38:55 +03:00
src fix findClass for UMLNoteOptions / UMLOptions unqualified classes 2023-03-28 18:58:28 +02:00
testdata Get rid of these margins, then we don't need port="p" anymore. 2018-10-28 13:34:16 +01:00
tools Do not update files for trivial differences 2014-10-28 20:15:40 +02:00
web Update index.html 2017-03-15 16:46:24 +01:00
.gitignore version running jdk9 2023-03-24 14:55:50 +01:00
.travis.yml Install GraphViz as a CI dependency 2018-10-24 12:52:55 +03:00
LICENSE Add license file, and clarify licensing terms, following suggestion by 2007-05-06 11:20:54 +00:00
Makefile Update project web page location 2016-09-16 23:38:47 +03:00
README.md update readme 2023-03-27 12:24:31 +02:00
TODO Refactor font handling. 2018-10-27 23:18:31 +02:00
build.xml Merge branch 'master' of github.com:dspinellis/UMLGraph 2019-03-25 22:17:17 +02:00
pom.template.xml Update project web page location 2016-09-16 23:38:47 +03:00
pom.xml [maven-release-plugin] prepare release R6_0_0 2023-05-23 14:59:31 +03:00
sequence.pic Remove obsolete RCS/CVS $Id$ 2014-10-28 16:29:43 +02:00
umlgraph Make umlgraph shell script work under Cygwin 2015-10-05 14:23:19 +03:00
umlgraph.bat Remove obsolete RCS/CVS $Id$ 2014-10-28 16:29:43 +02:00

README.md

UMLGraph - Declarative Drawing of UML Diagrams

Build Status

UMLGraph allows the declarative specification and drawing of UML diagrams. You can browse the system's documentation through this link, or print it through this link.

In order to run UMLGraph, you need to have GraphViz installed in your system path. On most Linux distributions, this can be easily installed using the regular package manager.

To compile the Java doclet from the source code run ant on the build.xml file.

If you change the source code, you can run regression tests by executing ant test.

Visit the project's home page for more information.

Compatibility

If you build against Java 8, please use latest version of 5.X of the Doclet.

Since Java 9 doclet APIs where completely rewritten, the Doclet in version 6 supports only supports Java 9 and above.

Development versions

In order to use development versions, you can use JitPack. Note that as this is compiled on demand, you may sometimes see a "Read timed out" when the package is recompiled, and it should be fine a few seconds later. And because the master branch can change any time, you may want to use a versioned snapshot instead (see the Jitpack documentation for details).

Gradle:

repositories { maven { url 'https://jitpack.io' } }
configurations { umlgraph }
dependencies { umlgraph 'com.github.dspinellis:UMLGraph:master-SNAPSHOT' }
javadoc {
  doclet = 'org.umlgraph.doclet.UmlGraphDoc'
  docletpath = configurations.umlgraph.files.asType(List)
  tags("hidden:X", "opt:X", "has:X", "navhas:X", "assoc:X", "navassoc:X",
       "composed:X", "navcomposed:X", "stereotype:X", "depend:X")
}

Maven:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
...
<dependency>
    <groupId>com.github.dspinellis</groupId>
    <artifactId>UMLGraph</artifactId>
    <version>master-SNAPSHOT</version>
    <scope>compile</scope>
</dependency>

Jar download: https://jitpack.io/com/github/dspinellis/UMLGraph/master-SNAPSHOT/UMLGraph-master-SNAPSHOT.jar