octoleo
/
plantuml
mirror of https://github.com/octoleo/plantuml.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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

This commit is contained in:
The-Lum 2023-11-17 10:31:18 +00:00
parent 546174d17f
commit 78a32d2743
9 changed files with 92 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/ext/plantuml/com/ctreber/readme.md Normal file
View File

@ -0,0 +1,12 @@
> [!WARNING]
> **Disclaimer**:
> This file was not part of the original package.
> It was included only on the PlantUML package to provide source citation and documentation.
# Directory Documentation for `ctreber`
## Description
Internal copy of `AC.earth` - `XEarth` for Java _(code of Christian Treber)_.
## See more information on
- [readme of `plantuml/acearth`](../../../../net/sourceforge/plantuml/acearth/readme.md)

2
src/net/sourceforge/plantuml/ditaa/package-info.java
View File

@ -3,7 +3,9 @@
* <a href="https://plantuml.com/ditaa" target="_top">
* Ditaa Diagram</a>.
*
* @see org.stathissideris.ascii2image.core
* @see org.stathissideris.ascii2image.graphics
* @see org.stathissideris.ascii2image.text
*
*/
package net.sourceforge.plantuml.ditaa;

7
src/net/sourceforge/plantuml/flowdiagram/package-info.java Normal file
View File

@ -0,0 +1,7 @@
/**
* Provides classes used to manage
* <a href="http://alphadoc.plantuml.com/doc/markdown/en/flow-diagram" target="_top">
* Flow Diagram</a>.
*
*/
package net.sourceforge.plantuml.flowdiagram;

11
src/net/sourceforge/plantuml/flowdiagram/readme.md Normal file
View File

@ -0,0 +1,11 @@
# Directory Documentation for `flowdiagram`
## Description
This package provides classes used to manage [PlantUML Flow Diagram](http://alphadoc.plantuml.com/doc/markdown/en/flow-diagram).
## Link
- [Flow Diagram _(on Alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/flow-diagram)
## Reference
- [GH-501](https://github.com/plantuml/plantuml/issues/501#issuecomment-805783661)
- [QA-13557](https://forum.plantuml.net/13557/support-for-the-different-%40start-commands)

12
src/net/sourceforge/plantuml/klimt/color/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/**
* Provides classes used to manage
* <a href="https://plantuml.com/color" target="_top">
* Color</a>.
*
* @see net.sourceforge.plantuml.help.CommandHelpColor
* @see net.sourceforge.plantuml.eggs.PSystemColorsFactory
* @see net.sourceforge.plantuml.klimt.creole.command.CommandCreoleColorAndSizeChange
* @see net.sourceforge.plantuml.klimt.creole.command.CommandCreoleColorChange
*
*/
package net.sourceforge.plantuml.klimt.color;

16
src/net/sourceforge/plantuml/klimt/color/readme.md Normal file
View File

@ -0,0 +1,16 @@
# Directory Documentation for `color`
## Description
This package provides classes used to manage [PlantUML Color](https://plantuml.com/color).
## Link
- [PlantUML Color](https://plantuml.com/color)
## Reference
## Credit or Inspiration
- [HSLuv, a developer friendly perceptual color space](https://www.kuon.ch/post/2020-03-08-hsluv/) by _Nicolas Goy_.
- [HSLuv color space](https://www.hsluv.org) by [_Alexei Boronine_](https://www.boronine.com)
- :octocat: [hsluv/hsluv-java](https://github.com/hsluv/hsluv-java)
- [Calculating Color Contrast](https://24ways.org/2010/calculating-color-contrast) by _Brian Suda_.
- [`HSLColor.java` _(on Web Archive)_](https://web.archive.org/web/20220328231936/http://www.camick.com/java/source/HSLColor.java)

7
src/net/sourceforge/plantuml/klimt/creole/package-info.java Normal file
View File

@ -0,0 +1,7 @@
/**
* Provides classes used to manage
* <a href="https://plantuml.com/creole" target="_top">
* Creole</a> (markup language).
*
*/
package net.sourceforge.plantuml.klimt.creole;

10
src/net/sourceforge/plantuml/klimt/creole/readme.md Normal file
View File

@ -0,0 +1,10 @@
# Directory Documentation for `creole`
## Description
This package provides classes used to manage [PlantUML Creole](https://plantuml.com/creole) markup language.
## Link
- [PlantUML Creole](https://plantuml.com/creole)
## Reference
- [Creole (markup) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Creole_(markup))

15
src/org/stathissideris/ascii2image/readme.md Normal file
View File

@ -0,0 +1,15 @@
> [!WARNING]
> **Disclaimer**:
> This file was not part of the original package.
> It was included only on the PlantUML package to provide source citation and documentation.
# Directory Documentation for `ascii2image`
## Description
Internal copy of `ditaa` _(code of Stathis Sideris)_.
## Credit
- :octocat: [stathissideris/ditaa](https://github.com/stathissideris/ditaa)
## See more information on
- [readme of `plantuml/ditaa`](../../../net/sourceforge/plantuml/ditaa/readme.md)