mirror of https://github.com/octoleo/plantuml.git
Merge pull request #1599 from The-Lum/ImproveDoc
docs: improve doc (JavaDoc, GH) [`package-info.java`, `readme.md`]
This commit is contained in:
PlantUML
GitHub
commit
76a27d5d9d
|
|
@ -0,0 +1,6 @@
|
|||
/**
|
||||
* Provides classes used to manage {@link Entity}.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.plasma
|
||||
*/
|
||||
package net.sourceforge.plantuml.abel;
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Directory Documentation for `abel`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [`Entity`](./Entity.java).
|
||||
|
||||
## Link
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
- [Abel _(on Wikipedia)_](https://en.wikipedia.org/wiki/Abel_(disambiguation))
|
||||
- [Niels Henrik Abel](https://en.wikipedia.org/wiki/Niels_Henrik_Abel)
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
/**
|
||||
* Provides classes used to generate
|
||||
* <a href="https://plantuml.com/xearth" target="_top">
|
||||
* XEarth Image</a>.
|
||||
*
|
||||
* @see ext.plantuml.com.ctreber.acearth
|
||||
*/
|
||||
package net.sourceforge.plantuml.acearth;
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# Directory Documentation for `acearth`
|
||||
|
||||
## Description
|
||||
This package provides classes used to generate [XEarth Image](https://plantuml.com/xearth).
|
||||
|
||||
The Java port of `XEarth` used in `PlantUML` is the [`AC.earth` of Christian Treber](../../../../ext/plantuml/com/ctreber/acearth/).
|
||||
|
||||
## Link
|
||||
- [XEarth Image _(on `PlantUML`)_](https://plantuml.com/xearth)
|
||||
|
||||
## Reference
|
||||
- [`xearth` of Kirk Lauritz Johnson](https://hewgill.com/xearth/original/)
|
||||
- [`xearth` for Windows of Greg Hewgill](https://hewgill.com/xearth/)
|
||||
|
||||
## Credit
|
||||
- [`AC.earth` of Christian Treber](../../../../ext/plantuml/com/ctreber/acearth/)
|
||||
- [AC Earth _(on Web Archive)_](https://web.archive.org/web/20180428011447/http://www.acproductions.de/acearth)
|
||||
|
||||
## Misc.
|
||||
- [Earth Day _(on Wikipedia)_](https://en.wikipedia.org/wiki/Earth_Day)
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
* Activity Diagram (legacy)</a>.
|
||||
*
|
||||
* <p>
|
||||
* For new syntax see {@link net/sourceforge/plantuml/activitydiagram3}
|
||||
* For new syntax see {@link net.sourceforge.plantuml.activitydiagram3}
|
||||
* and
|
||||
* <a href="https://plantuml.com/activity-diagram-beta" target="_top">
|
||||
* Activity Diagram (New Syntax)</a>.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
/**
|
||||
* Provides classes used to manage Java User Annotation on PlantUML.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.annotation;
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# Directory Documentation for `annotation`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage Java User Annotation on PlantUML.
|
||||
|
||||
Currently use to identify 'DeadCode' with the `@DeadCode` Annotation.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/ant-task)" target="_top">
|
||||
* PlantUML Ant task</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.ant;
|
||||
|
|
@ -5,5 +5,7 @@ This package provides classes used to manage [PlantUML Ant task](https://plantum
|
|||
|
||||
## Link
|
||||
- [PlantUML Ant task](https://plantuml.com/ant-task)
|
||||
- [Ant](https://ant.apache.org)
|
||||
- [Ant _(on Wikipedia)_](https://en.wikipedia.org/wiki/Apache_Ant)
|
||||
|
||||
## Reference
|
||||
- [Apache Ant](https://ant.apache.org)
|
||||
- [Apache Ant _(on Wikipedia)_](https://en.wikipedia.org/wiki/Apache_Ant)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
/**
|
||||
* Provides classes used to manage the Password-Hashing Function nammed
|
||||
* <a href="https://github.com/andreas1327250/argon2-java" target="_top">
|
||||
* Argon2</a>.
|
||||
*
|
||||
* <p>
|
||||
* The code is taken from:
|
||||
* <ul>
|
||||
* <li><a href="https://github.com/andreas1327250/argon2-java" target="_top">
|
||||
* Andreas1327250/Argon2-java</a></li>
|
||||
* <li><a href="https://github.com/alphazero/Blake2b/" target="_top">
|
||||
* Alphazero/Blake2b/</a></li>
|
||||
* </ul>
|
||||
* </p>
|
||||
* <p>
|
||||
* <i>Ref.</i>:
|
||||
* <ul>
|
||||
* <li><a href="https://github.com/P-H-C/phc-winner-argon2" target="_top">
|
||||
* P-H-C/PHC-winner-argon2</a></li>
|
||||
* <li><a href="https://www.password-hashing.net" target="_top">
|
||||
* Password Hashing Competition (PHC)</a></li>
|
||||
* </ul>
|
||||
* </p>
|
||||
*
|
||||
* @see net.sourceforge.plantuml.argon2.blake2
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.argon2;
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# Directory Documentation for `argon2`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage the password-hashing function nammed [Argon2](https://github.com/andreas1327250/argon2-java).
|
||||
|
||||
## Link
|
||||
- :octocat: [Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
|
||||
|
||||
## Reference
|
||||
- [Argon2 _(on Wikipedia)_](https://en.wikipedia.org/wiki/Argon2)
|
||||
- [RFC 9106 (Argon2)](https://datatracker.ietf.org/doc/html/rfc9106)
|
||||
- :octocat: [P-H-C/PHC-winner-argon2](https://github.com/P-H-C/phc-winner-argon2)
|
||||
- [Password Hashing Competition (PHC)](https://www.password-hashing.net)
|
||||
- [BLAKE2](https://www.blake2.net)
|
||||
- [RFC 7693 (BLAKE2)](https://datatracker.ietf.org/doc/html/rfc7693)
|
||||
|
||||
## Credit
|
||||
- :octocat: [Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
|
||||
- :octocat: [Alphazero/Blake2b](https://github.com/alphazero/Blake2b/)
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/ascii-art" target="_top">
|
||||
* ASCII Art output format</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.asciiart;
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Directory Documentation for `asciiart`
|
||||
|
||||
## Description
|
||||
This package provides classes used to export diagram to an [ASCII Art](https://plantuml.com/ascii-art) output format.
|
||||
|
||||
## Link
|
||||
- [ASCII Art Output Format](https://plantuml.com/ascii-art)
|
||||
- [ASCII Art _(on Wikipedia)_](https://en.wikipedia.org/wiki/ASCII_art)
|
||||
|
||||
## Reference
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="http://alphadoc.plantuml.com/doc/markdown/en/board-diagram" target="_top">
|
||||
* Board Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.board;
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Directory Documentation for `board`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Board Diagram](http://alphadoc.plantuml.com/doc/markdown/en/board-diagram).
|
||||
|
||||
## Link
|
||||
- [Board Diagram _(on Alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/board-diagram)
|
||||
|
||||
## Reference
|
||||
- [GH-423](https://github.com/plantuml/plantuml/issues/423)
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="http://alphadoc.plantuml.com/doc/markdown/en/bpmn" target="_top">
|
||||
* BPMN (Business Process Model and Notation) Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.bpm;
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Directory Documentation for `bpm`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML BPMN diagram](http://alphadoc.plantuml.com/doc/markdown/en/bpmn).
|
||||
|
||||
## Link
|
||||
- [BPMN Diagram _(on Alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/bpmn)
|
||||
- [BPMN _(on Wikipedia)_](https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation)
|
||||
|
||||
## Reference
|
||||
- [QA-5647](https://forum.plantuml.net/5647/plans-for-bpmn-support)
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/en/command-line#458de91d76a8569c" target="_top">
|
||||
* Braille output format</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.braille;
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Directory Documentation for `braille`
|
||||
|
||||
## Description
|
||||
This package provides classes used to export diagram to a [Braille](https://plantuml.com/en/command-line#458de91d76a8569c) output format.
|
||||
|
||||
## Link
|
||||
- [PlantUML Braille Output Format](https://plantuml.com/en/command-line#458de91d76a8569c)
|
||||
|
||||
## Reference
|
||||
- [QA-4752](https://forum.plantuml.net/4752/translate-class-diagram-to-braille)
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://github.com/google/brotli" target="_top">
|
||||
* Brotli Compression Algorithm</a>.
|
||||
*
|
||||
* <p>
|
||||
* The code is taken from:
|
||||
* <ul>
|
||||
* <li><a href="https://github.com/google/brotli" target="_top">
|
||||
* Google/Brotli</a></li>
|
||||
* </ul>
|
||||
* </p>
|
||||
*
|
||||
* @see net.sourceforge.plantuml.code.deflate
|
||||
* @see net.sourceforge.plantuml.zopfli
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.brotli;
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Directory Documentation for `brotli`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [Brotli Compression Algorithm](https://github.com/google/brotli).
|
||||
|
||||
## Link
|
||||
- :octocat: [Google/Brotli](https://github.com/google/brotli)
|
||||
|
||||
## Reference
|
||||
- [Brotli _(on Wikipedia)_](https://en.wikipedia.org/wiki/Brotli)
|
||||
- [RFC 7932](https://datatracker.ietf.org/doc/html/rfc7932)
|
||||
|
||||
## Credit
|
||||
- :octocat: [Google/Brotli](https://github.com/google/brotli)
|
||||
|
||||
## Misc.
|
||||
- [Brötchen _(on Wikipedia)_](https://de.wikipedia.org/wiki/Br%C3%B6tchen)
|
||||
- [Bread roll _(on Wikipedia)_](https://en.wikipedia.org/wiki/Bread_roll)
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/class-diagram" target="_top">
|
||||
* Class Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.classdiagram;
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Directory Documentation for `classdiagram`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Class Diagram](https://plantuml.com/class-diagram).
|
||||
|
||||
## Link
|
||||
- [Class Diagram](https://plantuml.com/class-diagram)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* Provides classes used to manage Coding and Compression.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.brotli
|
||||
* @see net.sourceforge.plantuml.code.deflate
|
||||
* @see net.sourceforge.plantuml.zopfli
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.code;
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# Directory Documentation for `code`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage Coding and Compression.
|
||||
|
||||
## Link
|
||||
- [`brotli`](../brotli/)
|
||||
- [`code.deflate`](./deflate/)
|
||||
- [`zopfli`](../zopfli/)
|
||||
|
||||
## Reference
|
||||
- [Simple DEFLATE decompressor](https://www.nayuki.io/page/simple-deflate-decompressor)
|
||||
- [RFC 1951 (DEFLATE)](https://datatracker.ietf.org/doc/html/rfc1951)
|
||||
|
||||
## Credit
|
||||
- :octocat: [Nayuki/Simple-DEFLATE-decompressor](https://github.com/nayuki/Simple-DEFLATE-decompressor)
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/commons" target="_top">
|
||||
* PlantUML End User Common Commands</a>.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.regex
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.command;
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Directory Documentation for `command`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML End User Common Commands](https://plantuml.com/commons).
|
||||
|
||||
## Link
|
||||
- [Common Commands in PlantUML](https://plantuml.com/commons)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
/**
|
||||
* Provides classes used to manage PlantUML Class-UseCase-Activity (CUCA) Diagram.
|
||||
*
|
||||
* <p>
|
||||
* The PlantUML CUCA Diagrams are:
|
||||
* <ul>
|
||||
* <li><a href="https://plantuml.com/class-diagram" target="_top">
|
||||
* Class Diagram</a>;</li>
|
||||
* <li><a href="https://plantuml.com/use-case-diagram" target="_top">
|
||||
* Use Case Diagram</a>;</li>
|
||||
* <li><a href="https://plantuml.com/activity-diagram-legacy" target="_top">
|
||||
* Activity Diagram (legacy)</a>.</li>
|
||||
* </ul>
|
||||
* </p>
|
||||
*/
|
||||
package net.sourceforge.plantuml.cucadiagram;
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# Directory Documentation for `cucadiagram`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage PlantUML Class-UseCase-Activity (CUCA) Diagram:
|
||||
- [Class Diagram](https://plantuml.com/class-diagram)
|
||||
- [Use Case Diagram](https://plantuml.com/use-case-diagram)
|
||||
- [Activity Diagram (legacy)](https://plantuml.com/activity-diagram-legacy)
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/dedication" target="_top">
|
||||
* Dedication</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.dedication;
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Directory Documentation for `dedication`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Dedication](https://plantuml.com/dedication).
|
||||
|
||||
## Link
|
||||
- [Dedication](https://plantuml.com/dedication)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/en/sources#dd263f8f99d9d776" target="_top">
|
||||
* Definition Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.definition;
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Directory Documentation for `definition`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Definition Diagram](https://plantuml.com/en/sources#dd263f8f99d9d776).
|
||||
|
||||
## Link
|
||||
|
||||
## Reference
|
||||
- [QA-5769](https://forum.plantuml.net/5769/please-provide-way-include-blocks-code-from-file-into-itself)
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
/**
|
||||
* Provides classes used to manage PlantUML Description Diagram.
|
||||
*
|
||||
* <p>
|
||||
* The PlantUML Description Diagrams are:
|
||||
* <ul>
|
||||
* <li><a href="https://plantuml.com/use-case-diagram" target="_top">
|
||||
* Use Case Diagram</a>;</li>
|
||||
* <li><a href="https://plantuml.com/component-diagram" target="_top">
|
||||
* Component Diagram</a>;</li>
|
||||
* <li><a href="https://plantuml.com/deployment-diagram" target="_top">
|
||||
* Deployment Diagram</a>;</li>
|
||||
* <li><a href="https://plantuml.com/archimate-diagram" target="_top">
|
||||
* Archimate Diagram</a>;</li>
|
||||
* <li><a href="http://alphadoc.plantuml.com/doc/markdown/en/problem-diagram"
|
||||
* target="_top">Problem Diagram</a>;</li>
|
||||
* <li><a href="https://plantuml.com/object-diagram" target="_top">
|
||||
* Object Diagram</a>.</li>
|
||||
* </ul>
|
||||
* </p>
|
||||
*/
|
||||
package net.sourceforge.plantuml.descdiagram;
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# Directory Documentation for `descdiagram`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage PlantUML Description Diagram:
|
||||
- [Use Case Diagram](https://plantuml.com/use-case-diagram)
|
||||
- [Component Diagram](https://plantuml.com/component-diagram)
|
||||
- [Deployment Diagram](https://plantuml.com/deployment-diagram)
|
||||
- [Archimate Diagram](https://plantuml.com/archimate-diagram)
|
||||
- [Problem Diagram](http://alphadoc.plantuml.com/doc/markdown/en/problem-diagram)
|
||||
- [Object Diagram](https://plantuml.com/object-diagram)
|
||||
|
||||
## Reference
|
||||
- [Architecture description language _(on Wikipedia)_](https://en.wikipedia.org/wiki/Architecture_description_language)
|
||||
- [Software architecture description _(on Wikipedia)_](https://en.wikipedia.org/wiki/Software_architecture_description)
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/dot" target="_top">
|
||||
* Dot Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.directdot;
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Directory Documentation for `directdot`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Dot Diagram](https://plantuml.com/dot).
|
||||
|
||||
## Link
|
||||
- [Dot Diagram](https://plantuml.com/dot)
|
||||
|
||||
## Reference
|
||||
- [Graphviz DOT Language](https://www.graphviz.org/doc/info/lang.html)
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/ditaa" target="_top">
|
||||
* Ditaa Diagram</a>.
|
||||
*
|
||||
* @see org.stathissideris.ascii2image.graphics
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.ditaa;
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Directory Documentation for `ditaa`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Ditaa Diagram](https://plantuml.com/ditaa).
|
||||
|
||||
## Link
|
||||
- [Ditaa Diagram](https://plantuml.com/ditaa)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
- [`org.stathissideris.ascii2image`](../../../../org/stathissideris/ascii2image) _(included in PlantUML)_
|
||||
- :octocat: [stathissideris/ditaa](https://github.com/stathissideris/ditaa)
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/donors" target="_top">
|
||||
* Donors</a> and
|
||||
* <a href="https://plantuml.com/skinparam" target="_top">
|
||||
* Skinparameter</a> Lists.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.donors;
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# Directory Documentation for `donors`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage:
|
||||
- [PlantUML Donors List](https://plantuml.com/donors)
|
||||
- [PlantUML Skinparameter List](https://plantuml.com/skinparam)
|
||||
|
||||
## Link
|
||||
- [PlantUML Donors](https://plantuml.com/donors)
|
||||
- [PlantUML Skinparameter](https://plantuml.com/skinparam)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/graphviz-dot" target="_top">
|
||||
* Graphviz dot</a> for layout engine.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.elk
|
||||
* @see net.sourceforge.plantuml.sdot
|
||||
* @see net.sourceforge.plantuml.vizjs
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.dot;
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# Directory Documentation for `dot`
|
||||
|
||||
## Description
|
||||
This package provides classes used to export diagram with the [Graphviz dot](https://plantuml.com/graphviz-dot) layout engine.
|
||||
|
||||
## Link
|
||||
- [Graphviz dot](https://plantuml.com/graphviz-dot)
|
||||
|
||||
## Reference
|
||||
- [Graphviz](https://graphviz.org)
|
||||
- [Graphviz _(on GitLab)_](https://gitlab.com/graphviz/graphviz/)
|
||||
|
||||
## See also other engines
|
||||
- [PlantUML 'Eclipse Layout Kernel (ELK)' Engine](https://plantuml.com/elk)
|
||||
- [`elk/proxy`](./proxy/) _(included in PlantUML)_
|
||||
- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
- [`plantuml/sdot`](../sdot/)
|
||||
- [`src/gen`](../../../../gen)
|
||||
- [`src/smetana/core`](../../../../smetana/core)
|
||||
- [`src/h`](../../../../h)
|
||||
- [PlantUML Vizjs _(a port to Javascript of GraphViz)_](https://plantuml.com/vizjs)
|
||||
- [`plantuml/vizjs`](../vizjs/) _(included in PlantUML)_
|
||||
- :octocat: [Plantuml/Vizjs](https://github.com/plantuml/vizjs) _(not included in `plantuml/plantuml`)_
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/ebnf" target="_top">
|
||||
* EBNF (Extended Backus–Naur Form) Diagram</a>.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.regexdiagram
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.ebnf;
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# Directory Documentation for `ebnf`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [Extended Backus–Naur Form (EBNF) Diagram](https://plantuml.com/ebnf).
|
||||
|
||||
## Link
|
||||
- [Extended Backus–Naur Form (EBNF) Diagram](https://plantuml.com/ebnf)
|
||||
|
||||
## Reference
|
||||
### Internal Reference
|
||||
- [QA-16529](https://forum.plantuml.net/16529/could-we-add-syntax-diagrams)
|
||||
|
||||
### External Reference
|
||||
- [Syntax diagram _(on Wikipedia)_](https://en.wikipedia.org/wiki/Syntax_diagram)
|
||||
- [Extended Backus–Naur Form (EBNF) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form)
|
||||
- [ISO/IEC 14977 : 1996(E)](http://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf)
|
||||
|
||||
## See also
|
||||
- [PlantUML Regular expression (Regex) Diagram](https://plantuml.com/regex)
|
||||
- [`regexdiagram`](../regexdiagram/) _(directory on plantuml)_
|
||||
|
||||
## Misc.
|
||||
- [Shunting yard algorithm](https://en.wikipedia.org/wiki/Shunting_yard_algorithm)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
/**
|
||||
* Provides classes used to manage PlantUML Easter Eggs.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.eggs;
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Directory Documentation for `eggs`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage PlantUML Easter Eggs.
|
||||
|
||||
## Link
|
||||
|
||||
## Reference
|
||||
- [Easter egg _(on Wikipedia)_](https://en.wikipedia.org/wiki/Easter_egg_(media))
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/elk" target="_top">
|
||||
* Eclipse Layout Kernel (ELK)</a> for layout engine.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.elk.proxy
|
||||
* @see net.sourceforge.plantuml.dot
|
||||
* @see net.sourceforge.plantuml.sdot
|
||||
* @see net.sourceforge.plantuml.vizjs
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.elk;
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# Directory Documentation for `elk`
|
||||
|
||||
## Description
|
||||
This package provides classes used to export diagram with the [Eclipse Layout Kernel (ELK)](https://plantuml.com/elk) layout engine.
|
||||
|
||||
## Link
|
||||
- [PlantUML 'Eclipse Layout Kernel (ELK)' Engine](https://plantuml.com/elk)
|
||||
|
||||
## Reference
|
||||
- [Eclipse Layout Kernel (ELK)](https://eclipse.dev/elk/)
|
||||
- [ELK Documentation](https://eclipse.dev/elk/documentation.html)
|
||||
|
||||
## Credit
|
||||
- [`elk/proxy`](./proxy/) _(included in PlantUML)_
|
||||
- :octocat: [eclipse/elk](https://github.com/eclipse/elk)
|
||||
|
||||
## See also other engines
|
||||
- [GraphViz dot](https://plantuml.com/graphviz-dot)
|
||||
- [`plantuml/dot`](../dot/)
|
||||
- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
- [`plantuml/sdot`](../sdot/)
|
||||
- [`src/gen`](../../../../gen)
|
||||
- [`src/smetana/core`](../../../../smetana/core)
|
||||
- [`src/h`](../../../../h)
|
||||
- [PlantUML Vizjs _(a port to Javascript of GraphViz)_](https://plantuml.com/vizjs)
|
||||
- [`plantuml/vizjs`](../vizjs/) _(included in PlantUML)_
|
||||
- :octocat: [Plantuml/Vizjs](https://github.com/plantuml/vizjs) _(not included in `plantuml/plantuml`)_
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/en/creole#68305e25f5788db0" target="_top">
|
||||
* PlantUML Emoji</a> icon set.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.openiconic
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.emoji;
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Directory Documentation for `emoji`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Emoji](https://plantuml.com/en/creole#68305e25f5788db0) icon set.
|
||||
|
||||
## Link
|
||||
- [PlantUML Emoji](https://plantuml.com/en/creole#68305e25f5788db0) icon set
|
||||
|
||||
## Credit
|
||||
- :octocat: [EmojiTwo/emojitwo](https://github.com/EmojiTwo/emojitwo)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
/**
|
||||
* Provides classes used to manage Error.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.error;
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# Directory Documentation for `error`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage Error.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage Folder and File.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.security.SFile
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.file;
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# Directory Documentation for `file`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage Folder and File.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="http://alphadoc.plantuml.com/doc/markdown/en/files-diagram" target="_top">
|
||||
* [Tree] Files diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.filesdiagram;
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Directory Documentation for `filesdiagram`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [[Tree] Files diagram](http://alphadoc.plantuml.com/doc/markdown/en/files-diagram).
|
||||
|
||||
## Link
|
||||
- [[Tree] Files diagram _(on alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/files-diagram)
|
||||
|
||||
## Reference
|
||||
- [GH-1448](https://github.com/plantuml/plantuml/issues/1448)
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* Flashcode especially QR Code (on PlantUML).
|
||||
*
|
||||
* @see ext.plantuml.com.google.zxing
|
||||
* @see net.sourceforge.plantuml.klimt.creole.atom.AtomImg#createQrcode
|
||||
*/
|
||||
package net.sourceforge.plantuml.flashcode;
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Directory Documentation for `flashcode`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage Flashcode especially QR Code (on PlantUML).
|
||||
|
||||
## Reference
|
||||
- [Barcode _(on Wikipedia)_](https://en.wikipedia.org/wiki/Barcode)
|
||||
- [QR code _(on Wikipedia)_](https://en.wikipedia.org/wiki/QR_code)
|
||||
|
||||
## Credit
|
||||
- [`com.google.zxing`](../../../../ext/plantuml/com/google/zxing/) _(included in PlantUML)_
|
||||
- :octocat: [zxing/zxing](https://github.com/zxing/zxing)
|
||||
|
||||
## Misc.
|
||||
- [Flashcode _(on Wikipedia)_](https://fr.wikipedia.org/wiki/Flashcode) [fr]
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/font" target="_top">
|
||||
* Font list</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.font;
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# Directory Documentation for `font`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [Font List](https://plantuml.com/font).
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/ftp" target="_top">
|
||||
* FTP server</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.ftp;
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Directory Documentation for `ftp`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage a [FTP](https://plantuml.com/ftp) server.
|
||||
|
||||
## Link
|
||||
- [PlantUML FTP server](https://plantuml.com/ftp)
|
||||
|
||||
## Reference
|
||||
- [QA-9235](https://forum.plantuml.net/9235/unexpected-ftp-session)
|
||||
|
||||
## Reference
|
||||
- [File Transfer Protocol _(on Wikipedia)_](https://en.wikipedia.org/wiki/File_Transfer_Protocol)
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* PlantUML Fun icon set.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.fun;
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# Directory Documentation for `fun`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage Fun icon or sprite set.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="http://alphadoc.plantuml.com/doc/markdown/en/git-diagram" target="_top">
|
||||
* Commits Git Log Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.gitlog;
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Directory Documentation for `gitlog`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Commits Git Log Diagram Diagram](http://alphadoc.plantuml.com/doc/markdown/en/git-diagram).
|
||||
|
||||
## Link
|
||||
- [PlantUML Commits Git Log Diagram Diagram _(on Alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/git-diagram)
|
||||
|
||||
## Reference
|
||||
- [QA-13557](https://forum.plantuml.net/13557/support-for-the-different-%40start-commands)
|
||||
- [GH-493](https://github.com/plantuml/plantuml/pull/493)
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
/**
|
||||
* Provides classes used to manage Graphml output format.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.graphml;
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Directory Documentation for `graphml`
|
||||
|
||||
## Description
|
||||
This package provides classes used to export diagram to a Graphml output format.
|
||||
|
||||
## Link
|
||||
- https://github.com/plantuml/plantuml/commit/a195b4e842b6775ea80a79f43218a0e9c905e406
|
||||
- [`graphml` search results on `plantuml/plantuml`](https://github.com/search?q=repo%3Aplantuml%2Fplantuml+graphml&type=code)
|
||||
- [QA-5307](https://forum.plantuml.net/5307/export-to-graphml)
|
||||
|
||||
## Reference
|
||||
- [GraphML _(on Wikipedia)_](https://en.wikipedia.org/wiki/GraphML)
|
||||
|
||||
|
||||
## See also
|
||||
- ["Generic Model Export" on `graphml` branch](https://github.com/plantuml/plantuml/blob/graphml/src/net/sourceforge/plantuml/graphml/docs/overview.md)
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="http://alphadoc.plantuml.com/doc/markdown/en/hcl" target="_top">
|
||||
* HCL diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.hcl;
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Directory Documentation for `hcl`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML HCL Diagram](http://alphadoc.plantuml.com/doc/markdown/en/hcl).
|
||||
|
||||
## Link
|
||||
- [HCL Diagram _(on alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/hcl)
|
||||
|
||||
## Reference
|
||||
- [QA-17357](https://forum.plantuml.net/17357/documentation-of-hcl-and-regex)
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
/**
|
||||
* Provides classes used to manage Help list.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.help;
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Directory Documentation for `help`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage:
|
||||
- `help color`
|
||||
- `help font`
|
||||
- `help keyword`
|
||||
- `help theme`
|
||||
- `help type`
|
||||
|
||||
## Link
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/en/command-line#458de91d76a8569c" target="_top">
|
||||
* HTML output format</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.html;
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
# Directory Documentation for `html`
|
||||
|
||||
## Description
|
||||
This package provides classes used to export diagram to a [HTML](https://plantuml.com/en/command-line#458de91d76a8569c) output format.
|
||||
|
||||
## Link
|
||||
- [PlantUML HTML Output Format](https://plantuml.com/en/command-line#458de91d76a8569c)
|
||||
|
||||
## Reference
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/jcckit" target="_top">
|
||||
* Jcckit Diagram</a>.
|
||||
*
|
||||
* @see jcckit
|
||||
*/
|
||||
package net.sourceforge.plantuml.jcckit;
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# Directory Documentation for `jcckit`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML JCCKit Diagram](https://plantuml.com/jcckit).
|
||||
|
||||
## Link
|
||||
- [JCCKit Diagram](https://plantuml.com/jcckit)
|
||||
|
||||
## Reference
|
||||
- [JCCKit _(on Sourceforge)_](https://jcckit.sourceforge.net)
|
||||
- [JCCKit User Guide](https://jcckit.sourceforge.net/UserGuide/index.html)
|
||||
- [JCCKit Examples](https://jcckit.sourceforge.net/examples.html)
|
||||
|
||||
## Credit
|
||||
- [`src/jcckit`](../../../../jcckit/) _(included in PlantUML)_
|
||||
- [JCCKit _(on Sourceforge)_](https://jcckit.sourceforge.net)
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage JSON Data (with the minimal-json API).
|
||||
*
|
||||
* @see <a href="https://github.com/ralfstx/minimal-json" target="_top">
|
||||
* Minimal-json API</a>
|
||||
*/
|
||||
package net.sourceforge.plantuml.json;
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Directory Documentation for `json`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [JSON](https://www.json.org) Data _(with the [minimal-json API](https://github.com/ralfstx/minimal-json))_.
|
||||
|
||||
## Link
|
||||
|
||||
## Reference
|
||||
- [JSON _(on Wikipedia)_](https://en.wikipedia.org/wiki/JSON)
|
||||
|
||||
## Credit
|
||||
- :octocat: [ralfstx/minimal-json](https://github.com/ralfstx/minimal-json)
|
||||
- [`json`](../json/) _(included in PlantUML)_
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/json" target="_top">
|
||||
* JSON Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.jsondiagram;
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Directory Documentation for `jsondiagram`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML JSON Diagram](https://plantuml.com/json).
|
||||
|
||||
## Link
|
||||
- [JSON Diagram](https://plantuml.com/json)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
/**
|
||||
* Provides classes used to manage Log and Logging.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.log;
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# Directory Documentation for `log`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage Log and Logging.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/ascii-math" target="_top">
|
||||
* ASCII Math format</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.math;
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# Directory Documentation for `math`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML ASCII Math](https://plantuml.com/ascii-math) format.
|
||||
|
||||
## Link
|
||||
- [PlantUML ASCII Math Format](https://plantuml.com/ascii-math)
|
||||
|
||||
## Reference
|
||||
- [Ascii Math](http://asciimath.org)
|
||||
- [JLaTeXMath](https://scilab.gitlab.io/legacy_wiki/JLaTeXMath)
|
||||
|
||||
## Credit
|
||||
- :octocat: [Asciimath/Asciimathml](https://github.com/asciimath/asciimathml/tree/master/asciimath-based)
|
||||
- [`ASCIIMathTeXImg.java`](./ASCIIMathTeXImg.java) is an internal port of [`ASCIIMathTeXImg.js`](https://github.com/asciimath/asciimathml/blob/master/asciimath-based/ASCIIMathTeXImg.js)
|
||||
- :octocat: [Opencollab/Jlatexmath](https://github.com/opencollab/jlatexmath)
|
||||
|
||||
## Dependency _(if available)_
|
||||
- `org.scilab.forge.jlatexmath`
|
||||
- `org.apache.batik`
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/mindmap-diagram" target="_top">
|
||||
* Mindmap Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.mindmap;
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Directory Documentation for `mindmap`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Mindmap Diagram](https://plantuml.com/mindmap-diagram).
|
||||
|
||||
## Link
|
||||
- [Mindmap Diagram](https://plantuml.com/mindmap-diagram)
|
||||
|
||||
## Reference
|
||||
- [Mind map _(on Wikipedia)_](https://en.wikipedia.org/wiki/Mind_map)
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/nwdiag" target="_top">
|
||||
* Network Diagram (nwdiag)</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.nwdiag;
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# Directory Documentation for `nwdiag`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Network Diagram (nwdiag)](https://plantuml.com/nwdiag).
|
||||
|
||||
## Link
|
||||
- [Network Diagram (nwdiag)](https://plantuml.com/nwdiag)
|
||||
|
||||
## Reference
|
||||
- [Computer network diagram _(on Wikipedia)_](https://en.wikipedia.org/wiki/Computer_network_diagram)
|
||||
|
||||
## Credit or Inspiration
|
||||
- [`nwdiag` of Takeshi Komiya](http://blockdiag.com/en/nwdiag/nwdiag-examples.html)
|
||||
- :octocat: [ Blockdiag/Nwdiag](https://github.com/blockdiag/nwdiag)
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/object-diagram" target="_top">
|
||||
* Object (object, map, json) Diagram</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.objectdiagram;
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# Directory Documentation for `objectdiagram`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Object Diagram](https://plantuml.com/object-diagram):
|
||||
- `object`
|
||||
- `map`
|
||||
- `json`
|
||||
|
||||
## Link
|
||||
- [Object Diagram](https://plantuml.com/object-diagram)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/openiconic" target="_top">
|
||||
* PlantUML Openiconic</a> icon set.
|
||||
*
|
||||
* @see net.sourceforge.plantuml.emoji
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.openiconic;
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Directory Documentation for `openiconic`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [PlantUML Openiconic](https://plantuml.com/openiconic) icon set.
|
||||
|
||||
## Link
|
||||
- [PlantUML Openiconic](https://plantuml.com/openiconic) icon set
|
||||
|
||||
## Credit
|
||||
- :octocat: [Iconic/Open-iconic](https://github.com/iconic/open-iconic)
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/oregon-trail" target="_top">
|
||||
* The Oregon Trail Game</a> on PlantUML.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.oregon;
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Directory Documentation for `oregon`
|
||||
|
||||
## Description
|
||||
This package provides classes used to play [The Oregon Trail Game](https://plantuml.com/oregon-trail) on PlantUML.
|
||||
|
||||
## Link
|
||||
- [The Oregon Trail Game](https://plantuml.com/oregon-trail)
|
||||
|
||||
## Reference
|
||||
- [The Oregon Trail _(on Wikipedia)_](https://en.wikipedia.org/wiki/The_Oregon_Trail_%28series%29)
|
||||
|
||||
## Credit or Inspiration
|
||||
- [`Westward Ho!` of David Ahl](http://www.atariarchives.org/bca/Chapter02_WestwardHo.php)
|
||||
|
||||
## Misc.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/pdf" target="_top">
|
||||
* PDF output format</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.pdf;
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Directory Documentation for `pdf`
|
||||
|
||||
## Description
|
||||
This package provides classes used to export diagram to a [PDF](https://plantuml.com/pdf) output format.
|
||||
|
||||
## Link
|
||||
- [PDF](https://plantuml.com/pdf)
|
||||
|
||||
## Reference
|
||||
- [PDF _(on Wikipedia)_](https://en.wikipedia.org/wiki/PDF)
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/picoweb" target="_top">
|
||||
* PlantUML PicoWeb Server</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.picoweb;
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Directory Documentation for `picoweb`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage a [PlantUML PicoWeb Server](https://plantuml.com/picoweb).
|
||||
|
||||
## Link
|
||||
- [PlantUML PicoWeb server](https://plantuml.com/picoweb)
|
||||
|
||||
## Reference
|
||||
|
||||
## Credit or Inspiration
|
||||
- ["Create a simple HTTP Web Server in Java"](https://www.ssaurel.com/blog/create-a-simple-http-web-server-in-java) on the [Sylvain Saurel Blog](https://www.ssaurel.com/blog/)
|
||||
- [`JavaHTTPServer.java` of Sylvain Saurel](https://gist.github.com/ssaurel/2e8462d70b9e61c4dd6df2dc2cd725d7)
|
||||
(on a [@ssaurel's gist](https://gist.github.com/ssaurel))
|
||||
|
||||
## Misc.
|
||||
- [`pico` on "Metric prefix" _(on Wikipedia)_](https://en.wikipedia.org/wiki/Metric_prefix)
|
||||
- [`pico-` on "Orders of magnitude" _(on Wikipedia)_](https://en.wikipedia.org/wiki/Orders_of_magnitude_(numbers)#10%E2%88%9212)
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/**
|
||||
* Provides classes used to manage
|
||||
* <a href="https://plantuml.com/en/command-line#458de91d76a8569c" target="_top">
|
||||
* PNG output format</a>.
|
||||
*
|
||||
*/
|
||||
package net.sourceforge.plantuml.png;
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue