forked from plantuml/plantuml
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoverview.html
58 lines (46 loc) · 2.27 KB
/
overview.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<!--
========================================================================
PlantUML : a free UML diagram generator
========================================================================
(C) Copyright 2009-2013, Arnaud Roques
Project Info: http://plantuml.sourceforge.net
This file is part of PlantUML.
PlantUML is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PlantUML distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details.
You should have received a copy of the GNU General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
USA.
[Java is a trademark or registered trademark of Sun Microsystems, Inc.
in the United States and other countries.]
Original Author: Arnaud Roques
-->
<body>
<p>PlantUML is an open-source component used to draw UML diagrams from their textual description.</p>
<h3>Overview</h3>
This documentation will <i>not</i> describe the PlantUML language description.
Please refer to <a href=http://plantuml.sourceforge.net>PlantUML site</a> for that.
<p>
Here, some information about how PlantUML is implemented will be provided to help the
integration of PlantUML with other programs.
<p>
Unfortunately, here, we have to raise a <b>warning</b>:
<br>
While PlantUML language description remains stable over version and follow ascending
compatibility, the <i>implementation</i> of PlantUML changes very often over time.
<p>
So if you use classes described in this documentation, it's very likely that you will have
an issue someday, because those class may change without any notice. They could even be deleted.
<p>It used to happen more often than you think over years, because we try to constantly improve the
general design of PlantUML, and this imply a continuous refactoring.
<p>The only exception is the <code>net.sourceforge.plantuml</code> package, that we will keep
as stable as possible over time.
<p>
<img src=doc-files/img1.png>
</body>