1
0
mirror of https://github.com/octoleo/plantuml.git synced 2024-12-25 04:06:08 +00:00

docs: add package-info.java and readme.md

(for `abel` to `command`)
This commit is contained in:
The-Lum 2023-10-17 10:16:34 +00:00
parent 172ac26e03
commit 28cc4638d6
28 changed files with 330 additions and 2 deletions

View File

@ -0,0 +1,6 @@
/**
* Provides classes used to manage {@link Entity}.
*
* @see {@link net.sourceforge.plantuml.plasma}
*/
package net.sourceforge.plantuml.abel;

View File

@ -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)

View File

@ -0,0 +1,8 @@
/**
* Provides classes used to generate
* <a href="https://plantuml.com/xearth" target="_top">
* XEarth Image</a>.
*
* @see {@link ext.plantuml.com.ctreber.acearth}
*/
package net.sourceforge.plantuml.acearth;

View File

@ -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)

View File

@ -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;

View File

@ -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)

View File

@ -0,0 +1,26 @@
/**
* 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>
*
*/
package net.sourceforge.plantuml.argon2;

View File

@ -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.

View File

@ -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;

View File

@ -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

View File

@ -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;

View File

@ -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)

View File

@ -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;

View File

@ -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.

View File

@ -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;

View File

@ -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)

View File

@ -0,0 +1,15 @@
/**
* 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>
*
*/
package net.sourceforge.plantuml.brotli;

View File

@ -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)

View File

@ -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;

View File

@ -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.

View File

@ -0,0 +1,9 @@
/**
* Provides classes used to manage Coding and Compression.
*
* @see {@link net.sourceforge.plantuml.brotli}
* @see {@link net.sourceforge.plantuml.code.deflate}
* @see {@link net.sourceforge.plantuml.zopfli}
*
*/
package net.sourceforge.plantuml.code;

View File

@ -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.

View File

@ -0,0 +1,7 @@
/**
* Provides classes used to manage PlantUML End User Common Command.
*
* @see {@link net.sourceforge.plantuml.regex}
*
*/
package net.sourceforge.plantuml.command;

View File

@ -0,0 +1,13 @@
# Directory Documentation for `command`
## Description
This package provides classes used to manage PlantUML End User Common Command.
## Link
## Reference
## Credit
## Misc.

View File

@ -0,0 +1,7 @@
/**
* Provides classes used to manage
* <a href="https://plantuml.com/ebnf" target="_top">
* EBNF (Extended BackusNaur Form) Diagram</a>.
*
*/
package net.sourceforge.plantuml.ebnf;

View File

@ -0,0 +1,15 @@
# Directory Documentation for `ebnf`
## Description
This package provides classes used to manage [Extended BackusNaur Form (EBNF) Diagram](https://plantuml.com/ebnf).
## Link
- [Extended BackusNaur Form (EBNF) Diagram](https://plantuml.com/ebnf)
## Reference
- [Extended BackusNaur Form (EBNF) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form)
## Credit
## Misc.

View 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;

View File

@ -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.