From cbab1c333fb76f0d2efc8e35ec7eb86b3ebac4af Mon Sep 17 00:00:00 2001
From: Benjamin Davies <bentendavies@gmail.com>
Date: Sat, 26 Aug 2023 14:50:34 +1200
Subject: [PATCH] Document base package

---
 .../plantuml/SourceFileReader.java            |  2 +-
 .../sourceforge/plantuml/package-info.java    | 65 +++++++++++++++++++
 .../plantuml/regex/package-info.java          |  2 +-
 3 files changed, 67 insertions(+), 2 deletions(-)
 create mode 100644 src/net/sourceforge/plantuml/package-info.java

diff --git a/src/net/sourceforge/plantuml/SourceFileReader.java b/src/net/sourceforge/plantuml/SourceFileReader.java
index 5213eae3b..4591c6dcf 100644
--- a/src/net/sourceforge/plantuml/SourceFileReader.java
+++ b/src/net/sourceforge/plantuml/SourceFileReader.java
@@ -147,7 +147,7 @@ public class SourceFileReader extends SourceFileReaderAbstract implements ISourc
 				suggested = SuggestedFile.fromOutputFile(new File(outputDirectory, newName),
 						getFileFormatOption().getFileFormat(), 0);
 			} else {
-				Log.info("We are going to create files in directory " + dir);
+				Log.info("We are going to create cypherfiles in directory " + dir);
 				suggested = SuggestedFile.fromOutputFile(new File(dir, getFileName()),
 						getFileFormatOption().getFileFormat(), 0);
 			}
diff --git a/src/net/sourceforge/plantuml/package-info.java b/src/net/sourceforge/plantuml/package-info.java
new file mode 100644
index 000000000..50d99c8be
--- /dev/null
+++ b/src/net/sourceforge/plantuml/package-info.java
@@ -0,0 +1,65 @@
+/* ========================================================================
+ * PlantUML : a free UML diagram generator
+ * ========================================================================
+ *
+ * (C) Copyright 2009-2024, Arnaud Roques
+ *
+ * Project Info:  https://plantuml.com
+ * 
+ * If you like this project or if you find it useful, you can support us at:
+ * 
+ * https://plantuml.com/patreon (only 1$ per month!)
+ * https://plantuml.com/paypal
+ * 
+ * This file is part of PlantUML.
+ *
+ * PlantUML is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * PlantUML distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
+ * USA.
+ *
+ *
+ * Original Author:  Benjamin Davies
+ * 
+ *
+ */
+
+/**
+ * Contains classes for processing PlantUML source files.
+ *
+ * <p>
+ * The following is a typical control flow PlantUML:
+ *
+ * <ul>
+ * <li>
+ * Arguments are parsed ({@link Run} constructs {@link Option}),
+ * </li>
+ * <li>
+ * Files are read ({@link Run} constructs {@link SourceFileReaderAbstract}),
+ * </li>
+ * <li>
+ * Files are split into blocks ({@link SourceFileReaderAbstract} constructs
+ * {@link BlockUmlBuilder}),
+ * <li>
+ * Blocks are pre-processed ({@link BlockUml} uses
+ * {@link net.sourceforge.plantuml.tim.TimLoader}),
+ * </li>
+ * <li>
+ * Blocks are processed and the output images saved ({@link Run} calls
+ * {@link SourceFileReaderAbstract#getGeneratedImages()} which calls
+ * {@link BlockUml#getDiagram()} which uses
+ * {@link PSystemBuilder}),
+ * </li>
+ * </ul>
+ */
+package net.sourceforge.plantuml;
diff --git a/src/net/sourceforge/plantuml/regex/package-info.java b/src/net/sourceforge/plantuml/regex/package-info.java
index 8733d4ee0..ee29d767e 100644
--- a/src/net/sourceforge/plantuml/regex/package-info.java
+++ b/src/net/sourceforge/plantuml/regex/package-info.java
@@ -46,7 +46,7 @@
  * Before a {@link RegexComposed} can be matched, it must first have each
  * of its constituent parts concatenated into one large regex string using
  * {@link RegexComposed#getFullSlow}. This string is then transformed by
- * {@link MyPattern.transform} to replace some macros (e.g. %s
+ * {@link MyPattern#transform} to replace some macros (e.g. %s
  * for whitespace, %q for single quote) and compiled using
  * {@link java.util.regex.Pattern#compile}.
  */