Merge pull request #1607 from The-Lum/ImproveDoc

docs: improve doc (JavaDoc, GH) [`package-info.java`, `readme.md`] (for flowdiagram, color, creole, sprite)

src/net/sourceforge/plantuml/acearth/package-info.java

@@ -3,6 +3,6 @@
  * <a href="https://plantuml.com/xearth" target="_top">
  * XEarth Image</a>.
  *
- * @see ext.plantuml.com.ctreber.acearth
+ * @see zext.plantuml.com.ctreber.acearth
  */
 package net.sourceforge.plantuml.acearth;

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.

src/net/sourceforge/plantuml/ditaa/package-info.java

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

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;

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.

src/net/sourceforge/plantuml/flowdiagram/package-info.java

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

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)

src/net/sourceforge/plantuml/klimt/color/package-info.java

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

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)

src/net/sourceforge/plantuml/klimt/creole/package-info.java

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

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

src/net/sourceforge/plantuml/klimt/sprite/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/sprite" target="_top">
+ * Sprite</a>.
+ *
+ * @see net.sourceforge.plantuml.klimt.sprite.CommandListSprite
+ * @see net.sourceforge.plantuml.klimt.sprite.CommandStdlib
+ * 
+ */
+package net.sourceforge.plantuml.klimt.sprite;

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)

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)

src/zext/plantuml/com/ctreber/acearth/package-info.java

@@ -9,7 +9,7 @@
  * Internal copy of <code>AC.earth</code> - <code>XEarth</code> 
  * for Java <i>(code of Christian Treber)</i>.
  * 
- * @see ext.plantuml.com.ctreber.acearth.ACearth
+ * @see zext.plantuml.com.ctreber.acearth.ACearth
  * @see net.sourceforge.plantuml.acearth
  * 
  */

src/zext/plantuml/com/ctreber/acearth/scanbit/ScanBit.java

@@ -53,7 +53,7 @@ public class ScanBit implements Comparable
 
   /**
    * <p>See values for
-   * @see ext.plantuml.com.ctreber.acearth.util.Polygon
+   * @see zext.plantuml.com.ctreber.acearth.util.Polygon
    */
   public int getType()
   {

src/zext/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)