From 78a32d2743247d8990944ccb9141fcadbe4ab107 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Fri, 17 Nov 2023 10:31:18 +0000 Subject: [PATCH] docs: add `package-info.java` and `readme.md` --- src/ext/plantuml/com/ctreber/readme.md | 12 ++++++++++++ .../sourceforge/plantuml/ditaa/package-info.java | 2 ++ .../plantuml/flowdiagram/package-info.java | 7 +++++++ .../sourceforge/plantuml/flowdiagram/readme.md | 11 +++++++++++ .../plantuml/klimt/color/package-info.java | 12 ++++++++++++ .../sourceforge/plantuml/klimt/color/readme.md | 16 ++++++++++++++++ .../plantuml/klimt/creole/package-info.java | 7 +++++++ .../sourceforge/plantuml/klimt/creole/readme.md | 10 ++++++++++ src/org/stathissideris/ascii2image/readme.md | 15 +++++++++++++++ 9 files changed, 92 insertions(+) create mode 100644 src/ext/plantuml/com/ctreber/readme.md create mode 100644 src/net/sourceforge/plantuml/flowdiagram/package-info.java create mode 100644 src/net/sourceforge/plantuml/flowdiagram/readme.md create mode 100644 src/net/sourceforge/plantuml/klimt/color/package-info.java create mode 100644 src/net/sourceforge/plantuml/klimt/color/readme.md create mode 100644 src/net/sourceforge/plantuml/klimt/creole/package-info.java create mode 100644 src/net/sourceforge/plantuml/klimt/creole/readme.md create mode 100644 src/org/stathissideris/ascii2image/readme.md diff --git a/src/ext/plantuml/com/ctreber/readme.md b/src/ext/plantuml/com/ctreber/readme.md new file mode 100644 index 00000000000..4438e1e9399 --- /dev/null +++ b/src/ext/plantuml/com/ctreber/readme.md @@ -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) diff --git a/src/net/sourceforge/plantuml/ditaa/package-info.java b/src/net/sourceforge/plantuml/ditaa/package-info.java index c2cbdbd4cdd..f0a3a50f556 100644 --- a/src/net/sourceforge/plantuml/ditaa/package-info.java +++ b/src/net/sourceforge/plantuml/ditaa/package-info.java @@ -3,7 +3,9 @@ * * Ditaa Diagram. * + * @see org.stathissideris.ascii2image.core * @see org.stathissideris.ascii2image.graphics + * @see org.stathissideris.ascii2image.text * */ package net.sourceforge.plantuml.ditaa; diff --git a/src/net/sourceforge/plantuml/flowdiagram/package-info.java b/src/net/sourceforge/plantuml/flowdiagram/package-info.java new file mode 100644 index 00000000000..c146b9255be --- /dev/null +++ b/src/net/sourceforge/plantuml/flowdiagram/package-info.java @@ -0,0 +1,7 @@ +/** + * Provides classes used to manage + * + * Flow Diagram. + * + */ +package net.sourceforge.plantuml.flowdiagram; diff --git a/src/net/sourceforge/plantuml/flowdiagram/readme.md b/src/net/sourceforge/plantuml/flowdiagram/readme.md new file mode 100644 index 00000000000..720bea98895 --- /dev/null +++ b/src/net/sourceforge/plantuml/flowdiagram/readme.md @@ -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) diff --git a/src/net/sourceforge/plantuml/klimt/color/package-info.java b/src/net/sourceforge/plantuml/klimt/color/package-info.java new file mode 100644 index 00000000000..1568496a957 --- /dev/null +++ b/src/net/sourceforge/plantuml/klimt/color/package-info.java @@ -0,0 +1,12 @@ +/** + * Provides classes used to manage + * + * Color. + * + * @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; diff --git a/src/net/sourceforge/plantuml/klimt/color/readme.md b/src/net/sourceforge/plantuml/klimt/color/readme.md new file mode 100644 index 00000000000..6d7808afbff --- /dev/null +++ b/src/net/sourceforge/plantuml/klimt/color/readme.md @@ -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) diff --git a/src/net/sourceforge/plantuml/klimt/creole/package-info.java b/src/net/sourceforge/plantuml/klimt/creole/package-info.java new file mode 100644 index 00000000000..99f501c2887 --- /dev/null +++ b/src/net/sourceforge/plantuml/klimt/creole/package-info.java @@ -0,0 +1,7 @@ +/** + * Provides classes used to manage + * + * Creole (markup language). + * + */ +package net.sourceforge.plantuml.klimt.creole; diff --git a/src/net/sourceforge/plantuml/klimt/creole/readme.md b/src/net/sourceforge/plantuml/klimt/creole/readme.md new file mode 100644 index 00000000000..d1dd36370d8 --- /dev/null +++ b/src/net/sourceforge/plantuml/klimt/creole/readme.md @@ -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)) diff --git a/src/org/stathissideris/ascii2image/readme.md b/src/org/stathissideris/ascii2image/readme.md new file mode 100644 index 00000000000..2428d1f1982 --- /dev/null +++ b/src/org/stathissideris/ascii2image/readme.md @@ -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)