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 1/4] 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 000000000..4438e1e93 --- /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 c2cbdbd4c..f0a3a50f5 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 000000000..c146b9255 --- /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 000000000..720bea988 --- /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 000000000..1568496a9 --- /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 000000000..6d7808afb --- /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 000000000..99f501c28 --- /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 000000000..d1dd36370 --- /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 000000000..2428d1f19 --- /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) From d5e42c9d7ee11515b6e77c27b982cf0e79c884ee Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Sun, 19 Nov 2023 14:38:44 +0000 Subject: [PATCH 2/4] fix: change `readme.md` to `zext` dir --- src/{ext => zext}/plantuml/com/ctreber/readme.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/{ext => zext}/plantuml/com/ctreber/readme.md (100%) diff --git a/src/ext/plantuml/com/ctreber/readme.md b/src/zext/plantuml/com/ctreber/readme.md similarity index 100% rename from src/ext/plantuml/com/ctreber/readme.md rename to src/zext/plantuml/com/ctreber/readme.md From 54117a5e8ba0fe9d322a16201b9fbb4138afdfa3 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Sun, 19 Nov 2023 15:10:09 +0000 Subject: [PATCH 3/4] fix: fix some links to `zext` instead of `ext`. --- src/net/sourceforge/plantuml/acearth/package-info.java | 2 +- src/net/sourceforge/plantuml/acearth/readme.md | 4 ++-- src/net/sourceforge/plantuml/flashcode/package-info.java | 2 +- src/net/sourceforge/plantuml/flashcode/readme.md | 2 +- src/zext/plantuml/com/ctreber/acearth/package-info.java | 2 +- src/zext/plantuml/com/ctreber/acearth/scanbit/ScanBit.java | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/net/sourceforge/plantuml/acearth/package-info.java b/src/net/sourceforge/plantuml/acearth/package-info.java index ff8536d87..26683cf61 100644 --- a/src/net/sourceforge/plantuml/acearth/package-info.java +++ b/src/net/sourceforge/plantuml/acearth/package-info.java @@ -3,6 +3,6 @@ * * XEarth Image. * - * @see ext.plantuml.com.ctreber.acearth + * @see zext.plantuml.com.ctreber.acearth */ package net.sourceforge.plantuml.acearth; diff --git a/src/net/sourceforge/plantuml/acearth/readme.md b/src/net/sourceforge/plantuml/acearth/readme.md index a369bb7a5..e5d8f1c1a 100644 --- a/src/net/sourceforge/plantuml/acearth/readme.md +++ b/src/net/sourceforge/plantuml/acearth/readme.md @@ -3,7 +3,7 @@ ## 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/). +The Java port of `XEarth` used in `PlantUML` is the [`AC.earth` of Christian Treber](../../../../zext/plantuml/com/ctreber/acearth/). ## Link - [XEarth Image _(on `PlantUML`)_](https://plantuml.com/xearth) @@ -13,7 +13,7 @@ The Java port of `XEarth` used in `PlantUML` is the [`AC.earth` of Christian Tre - [`xearth` for Windows of Greg Hewgill](https://hewgill.com/xearth/) ## Credit -- [`AC.earth` of Christian Treber](../../../../ext/plantuml/com/ctreber/acearth/) +- [`AC.earth` of Christian Treber](../../../../zext/plantuml/com/ctreber/acearth/) - [AC Earth _(on Web Archive)_](https://web.archive.org/web/20180428011447/http://www.acproductions.de/acearth) ## Misc. diff --git a/src/net/sourceforge/plantuml/flashcode/package-info.java b/src/net/sourceforge/plantuml/flashcode/package-info.java index e016dc1c9..1d995313b 100644 --- a/src/net/sourceforge/plantuml/flashcode/package-info.java +++ b/src/net/sourceforge/plantuml/flashcode/package-info.java @@ -2,7 +2,7 @@ * Provides classes used to manage * Flashcode especially QR Code (on PlantUML). * - * @see ext.plantuml.com.google.zxing + * @see zext.plantuml.com.google.zxing * @see net.sourceforge.plantuml.klimt.creole.atom.AtomImg#createQrcode */ package net.sourceforge.plantuml.flashcode; diff --git a/src/net/sourceforge/plantuml/flashcode/readme.md b/src/net/sourceforge/plantuml/flashcode/readme.md index 5d49c3123..eac30f0ae 100644 --- a/src/net/sourceforge/plantuml/flashcode/readme.md +++ b/src/net/sourceforge/plantuml/flashcode/readme.md @@ -8,7 +8,7 @@ This package provides classes used to manage Flashcode especially QR Code (on Pl - [QR code _(on Wikipedia)_](https://en.wikipedia.org/wiki/QR_code) ## Credit -- [`com.google.zxing`](../../../../ext/plantuml/com/google/zxing/) _(included in PlantUML)_ +- [`com.google.zxing`](../../../../zext/plantuml/com/google/zxing/) _(included in PlantUML)_ - :octocat: [zxing/zxing](https://github.com/zxing/zxing) ## Misc. diff --git a/src/zext/plantuml/com/ctreber/acearth/package-info.java b/src/zext/plantuml/com/ctreber/acearth/package-info.java index b0da411ce..89c59c62e 100644 --- a/src/zext/plantuml/com/ctreber/acearth/package-info.java +++ b/src/zext/plantuml/com/ctreber/acearth/package-info.java @@ -9,7 +9,7 @@ * Internal copy of AC.earth - XEarth * for Java (code of Christian Treber). * - * @see ext.plantuml.com.ctreber.acearth.ACearth + * @see zext.plantuml.com.ctreber.acearth.ACearth * @see net.sourceforge.plantuml.acearth * */ diff --git a/src/zext/plantuml/com/ctreber/acearth/scanbit/ScanBit.java b/src/zext/plantuml/com/ctreber/acearth/scanbit/ScanBit.java index 13367fe0f..e101629ec 100644 --- a/src/zext/plantuml/com/ctreber/acearth/scanbit/ScanBit.java +++ b/src/zext/plantuml/com/ctreber/acearth/scanbit/ScanBit.java @@ -53,7 +53,7 @@ public class ScanBit implements Comparable /** *

See values for - * @see ext.plantuml.com.ctreber.acearth.util.Polygon + * @see zext.plantuml.com.ctreber.acearth.util.Polygon */ public int getType() { From 37714ac1e20cd232200151193996895d4a11c328 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Sun, 19 Nov 2023 15:37:20 +0000 Subject: [PATCH 4/4] docs: add `package-info.java` and `readme.md` (for `klimt/sprite`) --- .../plantuml/klimt/sprite/package-info.java | 10 ++++++++++ .../sourceforge/plantuml/klimt/sprite/readme.md | 14 ++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 src/net/sourceforge/plantuml/klimt/sprite/package-info.java create mode 100644 src/net/sourceforge/plantuml/klimt/sprite/readme.md diff --git a/src/net/sourceforge/plantuml/klimt/sprite/package-info.java b/src/net/sourceforge/plantuml/klimt/sprite/package-info.java new file mode 100644 index 000000000..53dd54d25 --- /dev/null +++ b/src/net/sourceforge/plantuml/klimt/sprite/package-info.java @@ -0,0 +1,10 @@ +/** + * Provides classes used to manage + * + * Sprite. + * + * @see net.sourceforge.plantuml.klimt.sprite.CommandListSprite + * @see net.sourceforge.plantuml.klimt.sprite.CommandStdlib + * + */ +package net.sourceforge.plantuml.klimt.sprite; diff --git a/src/net/sourceforge/plantuml/klimt/sprite/readme.md b/src/net/sourceforge/plantuml/klimt/sprite/readme.md new file mode 100644 index 000000000..314f10af7 --- /dev/null +++ b/src/net/sourceforge/plantuml/klimt/sprite/readme.md @@ -0,0 +1,14 @@ +# Directory Documentation for `sprite` + +## Description +This package provides classes used to manage [PlantUML Sprite](https://plantuml.com/sprite). + +## Link +- [PlantUML Sprite](https://plantuml.com/sprite) + +## Reference + +## See also +- [PlantUML Standard Library](https://plantuml.com/stdlib) +- [`stdlib`](../../../../../../stdlib/) +- :octocat: [plantuml/plantuml-stdlib](https://github.com/plantuml/plantuml-stdlib)