From 1a3f5dfd60465f55831c975726ddb763a1e63207 Mon Sep 17 00:00:00 2001 From: Benjamin Davies Date: Sat, 26 Aug 2023 16:15:13 +1200 Subject: [PATCH] Document "PSystem" implied original meaning --- src/net/sourceforge/plantuml/AbstractPSystem.java | 9 +++++++++ src/net/sourceforge/plantuml/PSystemBuilder.java | 2 ++ src/net/sourceforge/plantuml/plasma/PEntry.java | 2 +- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/src/net/sourceforge/plantuml/AbstractPSystem.java b/src/net/sourceforge/plantuml/AbstractPSystem.java index bce725466..abebc8b07 100644 --- a/src/net/sourceforge/plantuml/AbstractPSystem.java +++ b/src/net/sourceforge/plantuml/AbstractPSystem.java @@ -67,6 +67,15 @@ import net.sourceforge.plantuml.utils.BlocLines; import net.sourceforge.plantuml.version.License; import net.sourceforge.plantuml.version.Version; +/** + * An abstract class for all diagram classes. + * + *

+ * Short for "{@link net.sourceforge.plantuml.plasma plasma} system", although + * most newer diagram types do not use entities stored in a plasma. + * + * @see PSystemBuilder + */ public abstract class AbstractPSystem implements Diagram { // ::remove file when __HAXE__ diff --git a/src/net/sourceforge/plantuml/PSystemBuilder.java b/src/net/sourceforge/plantuml/PSystemBuilder.java index f5b422d36..b3ebe8d81 100644 --- a/src/net/sourceforge/plantuml/PSystemBuilder.java +++ b/src/net/sourceforge/plantuml/PSystemBuilder.java @@ -114,6 +114,8 @@ import net.sourceforge.plantuml.yaml.YamlDiagramFactory; *

* Tries each of the factories (enumerated in the static block below) until one * succeeds. + * + * @see AbstractPSystem */ public class PSystemBuilder { // ::remove file when __HAXE__ diff --git a/src/net/sourceforge/plantuml/plasma/PEntry.java b/src/net/sourceforge/plantuml/plasma/PEntry.java index 1b0e667aa..9fefcedc7 100644 --- a/src/net/sourceforge/plantuml/plasma/PEntry.java +++ b/src/net/sourceforge/plantuml/plasma/PEntry.java @@ -37,7 +37,7 @@ package net.sourceforge.plantuml.plasma; /** * Keeps track of the {@link Quark} objects that have a given name. Short for - * {@link Plasma} entry. + * "{@link Plasma} entry". * *

* Tracks the first instace created with that name, as well as the number of