mirror of
https://github.com/octoleo/plantuml.git
synced 2024-12-01 09:14:01 +00:00
docs: add package-info.java
and readme.md
(for `dedication` to `png`)
This commit is contained in:
parent
28cc4638d6
commit
3a095fd7cb
@ -1,6 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
* Provides classes used to manage {@link Entity}.
|
* Provides classes used to manage {@link Entity}.
|
||||||
*
|
*
|
||||||
* @see {@link net.sourceforge.plantuml.plasma}
|
* @see net.sourceforge.plantuml.plasma
|
||||||
*/
|
*/
|
||||||
package net.sourceforge.plantuml.abel;
|
package net.sourceforge.plantuml.abel;
|
||||||
|
@ -3,6 +3,6 @@
|
|||||||
* <a href="https://plantuml.com/xearth" target="_top">
|
* <a href="https://plantuml.com/xearth" target="_top">
|
||||||
* XEarth Image</a>.
|
* XEarth Image</a>.
|
||||||
*
|
*
|
||||||
* @see {@link ext.plantuml.com.ctreber.acearth}
|
* @see ext.plantuml.com.ctreber.acearth
|
||||||
*/
|
*/
|
||||||
package net.sourceforge.plantuml.acearth;
|
package net.sourceforge.plantuml.acearth;
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
* Activity Diagram (legacy)</a>.
|
* Activity Diagram (legacy)</a>.
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
* For new syntax see {@link net/sourceforge/plantuml/activitydiagram3}
|
* For new syntax see {@link net.sourceforge.plantuml.activitydiagram3}
|
||||||
* and
|
* and
|
||||||
* <a href="https://plantuml.com/activity-diagram-beta" target="_top">
|
* <a href="https://plantuml.com/activity-diagram-beta" target="_top">
|
||||||
* Activity Diagram (New Syntax)</a>.
|
* Activity Diagram (New Syntax)</a>.
|
||||||
|
@ -22,5 +22,7 @@
|
|||||||
* </ul>
|
* </ul>
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
|
* @see net.sourceforge.plantuml.argon2.blake2
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
package net.sourceforge.plantuml.argon2;
|
package net.sourceforge.plantuml.argon2;
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
/**
|
/**
|
||||||
* Provides classes used to manage Coding and Compression.
|
* Provides classes used to manage Coding and Compression.
|
||||||
*
|
*
|
||||||
* @see {@link net.sourceforge.plantuml.brotli}
|
* @see net.sourceforge.plantuml.brotli
|
||||||
* @see {@link net.sourceforge.plantuml.code.deflate}
|
* @see net.sourceforge.plantuml.code.deflate
|
||||||
* @see {@link net.sourceforge.plantuml.zopfli}
|
* @see net.sourceforge.plantuml.zopfli
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
package net.sourceforge.plantuml.code;
|
package net.sourceforge.plantuml.code;
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
/**
|
/**
|
||||||
* Provides classes used to manage PlantUML End User Common Command.
|
* Provides classes used to manage
|
||||||
|
* <a href="https://plantuml.com/commons" target="_top">
|
||||||
|
* PlantUML End User Common Commands</a>.
|
||||||
*
|
*
|
||||||
* @see {@link net.sourceforge.plantuml.regex}
|
* @see net.sourceforge.plantuml.regex
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
package net.sourceforge.plantuml.command;
|
package net.sourceforge.plantuml.command;
|
||||||
|
@ -1,9 +1,10 @@
|
|||||||
# Directory Documentation for `command`
|
# Directory Documentation for `command`
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
This package provides classes used to manage PlantUML End User Common Command.
|
This package provides classes used to manage [PlantUML End User Common Commands](https://plantuml.com/commons).
|
||||||
|
|
||||||
## Link
|
## Link
|
||||||
|
- [Common Commands in PlantUML](https://plantuml.com/commons)
|
||||||
|
|
||||||
## Reference
|
## Reference
|
||||||
|
|
||||||
|
@ -0,0 +1,7 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage
|
||||||
|
* <a href="https://plantuml.com/dedication" target="_top">
|
||||||
|
* Dedication</a>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.dedication;
|
13
src/net/sourceforge/plantuml/dedication/readme.md
Normal file
13
src/net/sourceforge/plantuml/dedication/readme.md
Normal file
@ -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;
|
14
src/net/sourceforge/plantuml/definition/readme.md
Normal file
14
src/net/sourceforge/plantuml/definition/readme.md
Normal file
@ -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.
|
||||||
|
|
22
src/net/sourceforge/plantuml/descdiagram/package-info.java
Normal file
22
src/net/sourceforge/plantuml/descdiagram/package-info.java
Normal file
@ -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;
|
19
src/net/sourceforge/plantuml/descdiagram/readme.md
Normal file
19
src/net/sourceforge/plantuml/descdiagram/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/directdot/package-info.java
Normal file
7
src/net/sourceforge/plantuml/directdot/package-info.java
Normal file
@ -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;
|
15
src/net/sourceforge/plantuml/directdot/readme.md
Normal file
15
src/net/sourceforge/plantuml/directdot/readme.md
Normal file
@ -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.
|
||||||
|
|
8
src/net/sourceforge/plantuml/ditaa/package-info.java
Normal file
8
src/net/sourceforge/plantuml/ditaa/package-info.java
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage
|
||||||
|
* <a href="https://plantuml.com/ditaa" target="_top">
|
||||||
|
* Ditaa Diagram</a>.
|
||||||
|
*
|
||||||
|
* @see org.stathissideris.ascii2image
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.ditaa;
|
16
src/net/sourceforge/plantuml/ditaa/readme.md
Normal file
16
src/net/sourceforge/plantuml/ditaa/readme.md
Normal file
@ -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.
|
||||||
|
|
9
src/net/sourceforge/plantuml/donors/package-info.java
Normal file
9
src/net/sourceforge/plantuml/donors/package-info.java
Normal file
@ -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;
|
17
src/net/sourceforge/plantuml/donors/readme.md
Normal file
17
src/net/sourceforge/plantuml/donors/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/dot/package-info.java
Normal file
7
src/net/sourceforge/plantuml/dot/package-info.java
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage
|
||||||
|
* <a href="https://plantuml.com/graphviz-dot" target="_top">
|
||||||
|
* Graphviz dot</a> for layout engine.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.dot;
|
19
src/net/sourceforge/plantuml/dot/readme.md
Normal file
19
src/net/sourceforge/plantuml/dot/readme.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# 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)
|
||||||
|
- [Eclipse Layout Kernel (ELK)](https://eclipse.dev/elk/)
|
||||||
|
- [Smetana _(internal port of GraphViz in plantuml)_](https://plantuml.com/smetana02) and [:octocat:plantuml/smetana](https://github.com/plantuml/smetana)
|
||||||
|
- [`src/gen`](../../../../gen)
|
||||||
|
- [`src/smetana/core`](../../../../smetana/core)
|
||||||
|
- [`src/h`](../../../../h)
|
@ -8,8 +8,9 @@ This package provides classes used to manage [Extended Backus–Naur Form (EBNF)
|
|||||||
|
|
||||||
## Reference
|
## Reference
|
||||||
- [Extended Backus–Naur Form (EBNF) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form)
|
- [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)
|
||||||
|
|
||||||
## Credit
|
## Credit
|
||||||
|
|
||||||
## Misc.
|
## Misc.
|
||||||
|
- [Shunting yard algorithm](https://en.wikipedia.org/wiki/Shunting_yard_algorithm)
|
||||||
|
5
src/net/sourceforge/plantuml/eggs/package-info.java
Normal file
5
src/net/sourceforge/plantuml/eggs/package-info.java
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage PlantUML Easter Eggs.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.eggs;
|
14
src/net/sourceforge/plantuml/eggs/readme.md
Normal file
14
src/net/sourceforge/plantuml/eggs/readme.md
Normal file
@ -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.
|
||||||
|
|
9
src/net/sourceforge/plantuml/elk/package-info.java
Normal file
9
src/net/sourceforge/plantuml/elk/package-info.java
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
/**
|
||||||
|
* 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
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.elk;
|
23
src/net/sourceforge/plantuml/elk/readme.md
Normal file
23
src/net/sourceforge/plantuml/elk/readme.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# 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)
|
||||||
|
- [`src/gen`](../../../../gen)
|
||||||
|
- [`src/smetana/core`](../../../../smetana/core)
|
||||||
|
- [`src/h`](../../../../h)
|
5
src/net/sourceforge/plantuml/error/package-info.java
Normal file
5
src/net/sourceforge/plantuml/error/package-info.java
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage Error.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.error;
|
4
src/net/sourceforge/plantuml/error/readme.md
Normal file
4
src/net/sourceforge/plantuml/error/readme.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Directory Documentation for `error`
|
||||||
|
|
||||||
|
## Description
|
||||||
|
This package provides classes used to manage Error.
|
7
src/net/sourceforge/plantuml/font/package-info.java
Normal file
7
src/net/sourceforge/plantuml/font/package-info.java
Normal file
@ -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;
|
4
src/net/sourceforge/plantuml/font/readme.md
Normal file
4
src/net/sourceforge/plantuml/font/readme.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Directory Documentation for `font`
|
||||||
|
|
||||||
|
## Description
|
||||||
|
This package provides classes used to manage [Font List](https://plantuml.com/font).
|
7
src/net/sourceforge/plantuml/ftp/package-info.java
Normal file
7
src/net/sourceforge/plantuml/ftp/package-info.java
Normal file
@ -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;
|
11
src/net/sourceforge/plantuml/ftp/readme.md
Normal file
11
src/net/sourceforge/plantuml/ftp/readme.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# 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)
|
||||||
|
|
5
src/net/sourceforge/plantuml/graphml/package-info.java
Normal file
5
src/net/sourceforge/plantuml/graphml/package-info.java
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage Graphml output format.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.graphml;
|
16
src/net/sourceforge/plantuml/graphml/readme.md
Normal file
16
src/net/sourceforge/plantuml/graphml/readme.md
Normal file
@ -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)
|
7
src/net/sourceforge/plantuml/hcl/package-info.java
Normal file
7
src/net/sourceforge/plantuml/hcl/package-info.java
Normal file
@ -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;
|
15
src/net/sourceforge/plantuml/hcl/readme.md
Normal file
15
src/net/sourceforge/plantuml/hcl/readme.md
Normal file
@ -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.
|
||||||
|
|
5
src/net/sourceforge/plantuml/help/package-info.java
Normal file
5
src/net/sourceforge/plantuml/help/package-info.java
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage help list.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.help;
|
18
src/net/sourceforge/plantuml/help/readme.md
Normal file
18
src/net/sourceforge/plantuml/help/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/html/package-info.java
Normal file
7
src/net/sourceforge/plantuml/html/package-info.java
Normal file
@ -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;
|
9
src/net/sourceforge/plantuml/html/readme.md
Normal file
9
src/net/sourceforge/plantuml/html/readme.md
Normal file
@ -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
|
8
src/net/sourceforge/plantuml/jcckit/package-info.java
Normal file
8
src/net/sourceforge/plantuml/jcckit/package-info.java
Normal file
@ -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;
|
19
src/net/sourceforge/plantuml/jcckit/readme.md
Normal file
19
src/net/sourceforge/plantuml/jcckit/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/json/package-info.java
Normal file
7
src/net/sourceforge/plantuml/json/package-info.java
Normal file
@ -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;
|
16
src/net/sourceforge/plantuml/json/readme.md
Normal file
16
src/net/sourceforge/plantuml/json/readme.md
Normal file
@ -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;
|
14
src/net/sourceforge/plantuml/jsondiagram/readme.md
Normal file
14
src/net/sourceforge/plantuml/jsondiagram/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/log/package-info.java
Normal file
7
src/net/sourceforge/plantuml/log/package-info.java
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage Log and Logging.
|
||||||
|
*
|
||||||
|
* @see java.util.logging
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.log;
|
4
src/net/sourceforge/plantuml/log/readme.md
Normal file
4
src/net/sourceforge/plantuml/log/readme.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Directory Documentation for `log`
|
||||||
|
|
||||||
|
## Description
|
||||||
|
This package provides classes used to manage Log and Logging.
|
7
src/net/sourceforge/plantuml/math/package-info.java
Normal file
7
src/net/sourceforge/plantuml/math/package-info.java
Normal file
@ -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;
|
20
src/net/sourceforge/plantuml/math/readme.md
Normal file
20
src/net/sourceforge/plantuml/math/readme.md
Normal file
@ -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`
|
7
src/net/sourceforge/plantuml/mindmap/package-info.java
Normal file
7
src/net/sourceforge/plantuml/mindmap/package-info.java
Normal file
@ -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;
|
15
src/net/sourceforge/plantuml/mindmap/readme.md
Normal file
15
src/net/sourceforge/plantuml/mindmap/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/nwdiag/package-info.java
Normal file
7
src/net/sourceforge/plantuml/nwdiag/package-info.java
Normal file
@ -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;
|
16
src/net/sourceforge/plantuml/nwdiag/readme.md
Normal file
16
src/net/sourceforge/plantuml/nwdiag/readme.md
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
# 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)
|
||||||
|
|
||||||
|
## 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;
|
17
src/net/sourceforge/plantuml/objectdiagram/readme.md
Normal file
17
src/net/sourceforge/plantuml/objectdiagram/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/oregon/package-info.java
Normal file
7
src/net/sourceforge/plantuml/oregon/package-info.java
Normal file
@ -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;
|
16
src/net/sourceforge/plantuml/oregon/readme.md
Normal file
16
src/net/sourceforge/plantuml/oregon/readme.md
Normal file
@ -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.
|
||||||
|
|
7
src/net/sourceforge/plantuml/pdf/package-info.java
Normal file
7
src/net/sourceforge/plantuml/pdf/package-info.java
Normal file
@ -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;
|
10
src/net/sourceforge/plantuml/pdf/readme.md
Normal file
10
src/net/sourceforge/plantuml/pdf/readme.md
Normal file
@ -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)
|
7
src/net/sourceforge/plantuml/picoweb/package-info.java
Normal file
7
src/net/sourceforge/plantuml/picoweb/package-info.java
Normal file
@ -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;
|
18
src/net/sourceforge/plantuml/picoweb/readme.md
Normal file
18
src/net/sourceforge/plantuml/picoweb/readme.md
Normal file
@ -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)
|
7
src/net/sourceforge/plantuml/png/package-info.java
Normal file
7
src/net/sourceforge/plantuml/png/package-info.java
Normal file
@ -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;
|
10
src/net/sourceforge/plantuml/png/readme.md
Normal file
10
src/net/sourceforge/plantuml/png/readme.md
Normal file
@ -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)
|
7
src/net/sourceforge/plantuml/project/package-info.java
Normal file
7
src/net/sourceforge/plantuml/project/package-info.java
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
/**
|
||||||
|
* Provides classes used to manage
|
||||||
|
* <a href="https://plantuml.com/gantt-diagram" target="_top">
|
||||||
|
* Gantt Diagram</a>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sourceforge.plantuml.project;
|
15
src/net/sourceforge/plantuml/project/readme.md
Normal file
15
src/net/sourceforge/plantuml/project/readme.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Directory Documentation for `project`
|
||||||
|
|
||||||
|
## Description
|
||||||
|
This package provides classes used to manage [PlantUML Gantt Diagram](https://plantuml.com/gantt-diagram).
|
||||||
|
|
||||||
|
## Link
|
||||||
|
- [Gantt Diagram](https://plantuml.com/gantt-diagram)
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
- [Gantt chart _(on Wikipedia)_](https://en.wikipedia.org/wiki/Gantt_chart)
|
||||||
|
|
||||||
|
## Credit
|
||||||
|
|
||||||
|
## Misc.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user