1
0
mirror of https://github.com/octoleo/plantuml.git synced 2024-12-19 17:23:25 +00:00
plantuml/src/overview.html
2017-04-05 19:37:42 +02:00

59 lines
2.3 KiB
HTML

<!--
========================================================================
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>