From 6e85bcaac94ec364f33cd2a2f62ffe1d20d218e5 Mon Sep 17 00:00:00 2001
From: The-Lum <86879521+The-Lum@users.noreply.github.com>
Date: Thu, 16 Nov 2023 11:08:55 +0000
Subject: [PATCH] docs: add `package-info.java` and `readme.md` For external
 code: - acearth, - zxing, - jcckit, - ditaa.

---
 .../com/ctreber/acearth/package-info.java        | 16 ++++++++++++++++
 src/ext/plantuml/com/ctreber/acearth/readme.md   | 12 ++++++++++++
 .../plantuml/com/google/zxing/package-info.java  | 16 ++++++++++++++++
 src/ext/plantuml/com/google/zxing/readme.md      | 15 +++++++++++++++
 src/h/package-info.java                          |  4 ++--
 src/jcckit/package-info.java                     | 16 ++++++++++++++++
 src/jcckit/readme.md                             | 15 +++++++++++++++
 .../ascii2image/core/package-info.java           | 16 ++++++++++++++++
 .../stathissideris/ascii2image/core/readme.md    | 15 +++++++++++++++
 src/smetana/core/package-info.java               |  4 ++--
 10 files changed, 125 insertions(+), 4 deletions(-)
 create mode 100644 src/ext/plantuml/com/ctreber/acearth/package-info.java
 create mode 100644 src/ext/plantuml/com/ctreber/acearth/readme.md
 create mode 100644 src/ext/plantuml/com/google/zxing/package-info.java
 create mode 100644 src/ext/plantuml/com/google/zxing/readme.md
 create mode 100644 src/jcckit/package-info.java
 create mode 100644 src/jcckit/readme.md
 create mode 100644 src/org/stathissideris/ascii2image/core/package-info.java
 create mode 100644 src/org/stathissideris/ascii2image/core/readme.md

diff --git a/src/ext/plantuml/com/ctreber/acearth/package-info.java b/src/ext/plantuml/com/ctreber/acearth/package-info.java
new file mode 100644
index 00000000000..8e69ae42dba
--- /dev/null
+++ b/src/ext/plantuml/com/ctreber/acearth/package-info.java
@@ -0,0 +1,16 @@
+/*
+ * ⚠ Disclaimer 🚩
+ * This file was not part of the original package.
+ * It was included only on the PlantUML package 
+ * to provide source citation and documentation.
+ *
+ */
+/**
+ * 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 net.sourceforge.plantuml.acearth
+ * 
+ */
+package ext.plantuml.com.ctreber.acearth;
diff --git a/src/ext/plantuml/com/ctreber/acearth/readme.md b/src/ext/plantuml/com/ctreber/acearth/readme.md
new file mode 100644
index 00000000000..2fc76d57029
--- /dev/null
+++ b/src/ext/plantuml/com/ctreber/acearth/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 `acearth`
+
+## 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/ext/plantuml/com/google/zxing/package-info.java b/src/ext/plantuml/com/google/zxing/package-info.java
new file mode 100644
index 00000000000..a2d28d364fe
--- /dev/null
+++ b/src/ext/plantuml/com/google/zxing/package-info.java
@@ -0,0 +1,16 @@
+/*
+ * ⚠ Disclaimer 🚩
+ * This file was not part of the original package.
+ * It was included only on the PlantUML package 
+ * to provide source citation and documentation.
+ *
+ */
+/**
+ * Internal copy of 
+ * <a href="https://github.com/zxing/zxing" target="_top">
+ * <code>ZXing</code></a> <i>(code of Google)</i>.
+ * 
+ * @see net.sourceforge.plantuml.flashcode
+ * 
+ */
+package ext.plantuml.com.google.zxing;
diff --git a/src/ext/plantuml/com/google/zxing/readme.md b/src/ext/plantuml/com/google/zxing/readme.md
new file mode 100644
index 00000000000..fb27815b329
--- /dev/null
+++ b/src/ext/plantuml/com/google/zxing/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 `zxing`
+
+## Description
+Internal copy of `ZXing` _(code of Google)_.
+
+## Credit
+- :octocat: [zxing/zxing](https://github.com/zxing/zxing)
+
+## See more information on
+- [readme of `plantuml/flashcode`](../../../../../net/sourceforge/plantuml/flashcode/readme.md)
diff --git a/src/h/package-info.java b/src/h/package-info.java
index dff6c2a4620..154188af613 100644
--- a/src/h/package-info.java
+++ b/src/h/package-info.java
@@ -12,9 +12,9 @@
  * </ul>
  * </p>
  * 
- * @see gen
+ * @see "gen"
  * @see gen.annotation
- * @see gen.lib
+ * @see "gen.lib"
  * @see gen.plugin.dot_layout
  * @see smetana.core
  * @see net.sourceforge.plantuml.sdot
diff --git a/src/jcckit/package-info.java b/src/jcckit/package-info.java
new file mode 100644
index 00000000000..6bc88456f89
--- /dev/null
+++ b/src/jcckit/package-info.java
@@ -0,0 +1,16 @@
+/*
+ * ⚠ Disclaimer 🚩
+ * This file was not part of the original package.
+ * It was included only on the PlantUML package 
+ * to provide source citation and documentation.
+ *
+ */
+/**
+ * Internal copy of 
+ * <a href="https://jcckit.sourceforge.net" target="_top">
+ * <code>JCCKit</code></a> <i>(code of Franz-Josef Elmer)</i>.
+ * 
+ * @see net.sourceforge.plantuml.jcckit
+ * 
+ */
+package jcckit;
diff --git a/src/jcckit/readme.md b/src/jcckit/readme.md
new file mode 100644
index 00000000000..19b4239f560
--- /dev/null
+++ b/src/jcckit/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 `jcckit`
+
+## Description
+Internal copy of `JCCKit` _(code of Franz-Josef Elmer)_.
+
+## Credit
+- [JCCKit _(on Sourceforge)_](https://jcckit.sourceforge.net)
+
+## See more information on
+- [readme of `plantuml/jcckit`](../net/sourceforge/plantuml/jcckit/readme.md)
diff --git a/src/org/stathissideris/ascii2image/core/package-info.java b/src/org/stathissideris/ascii2image/core/package-info.java
new file mode 100644
index 00000000000..d39d0688a28
--- /dev/null
+++ b/src/org/stathissideris/ascii2image/core/package-info.java
@@ -0,0 +1,16 @@
+/*
+ * ⚠ Disclaimer 🚩
+ * This file was not part of the original package.
+ * It was included only on the PlantUML package 
+ * to provide source citation and documentation.
+ *
+ */
+/**
+ * Internal copy of 
+ * <a href="https://github.com/stathissideris/ditaa" target="_top">
+ * <code>ditaa</code></a> <i>(code of Stathis Sideris)</i>.
+ * 
+ * @see net.sourceforge.plantuml.ditaa
+ * 
+ */
+package org.stathissideris.ascii2image.core;
diff --git a/src/org/stathissideris/ascii2image/core/readme.md b/src/org/stathissideris/ascii2image/core/readme.md
new file mode 100644
index 00000000000..f79ec3ec5c5
--- /dev/null
+++ b/src/org/stathissideris/ascii2image/core/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 `core`
+
+## 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)
diff --git a/src/smetana/core/package-info.java b/src/smetana/core/package-info.java
index 05aa05a4f30..0d726853135 100644
--- a/src/smetana/core/package-info.java
+++ b/src/smetana/core/package-info.java
@@ -5,9 +5,9 @@
  * in <a href="https://plantuml.com/smetana02" target="_top">plantuml</a>.
  *
  * @see h
- * @see gen
+ * @see "gen"
  * @see gen.annotation
- * @see gen.lib
+ * @see "gen.lib"
  * @see gen.plugin.dot_layout
  * @see net.sourceforge.plantuml.sdot
  *