More docs

phax · Feb 6, 2024 · e112464 · e112464
1 parent 6e405e5
commit e112464
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/phive-ves-engine/src/main/java/com/helger/phive/ves/engine/load/LoadedVES.java b/phive-ves-engine/src/main/java/com/helger/phive/ves/engine/load/LoadedVES.java
@@ -104,7 +104,9 @@ public EVESSyntax getVESSyntax ()
   }
 
   /**
-   * The potentially mutable part of a loaded VES.
+   * The potentially mutable part of a loaded VES. This is the syntax
+   * independent version of the status, in case there will be more then one
+   * version.
    *
    * @author Philip Helger
    */

diff --git a/phive-ves-engine/src/main/java/com/helger/phive/ves/engine/load/VESLoader.java b/phive-ves-engine/src/main/java/com/helger/phive/ves/engine/load/VESLoader.java
@@ -78,8 +78,15 @@
 @ThreadSafe
 public final class VESLoader
 {
+  /**
+   * File extension for VES files
+   */
   public static final String FILE_EXT_VES = ".ves";
+  /**
+   * File extension for status files
+   */
   public static final String FILE_EXT_STATUS = ".status";
+
   public static final boolean DEFAULT_USE_EAGER_REQUIREMENT_LOADING = false;
 
   private static final Logger LOGGER = LoggerFactory.getLogger (VESLoader.class);
@@ -490,6 +497,7 @@ public LoadedVES loadVESFromRepo (@Nonnull final VESID aVESID,
     // Ensure the VESID is not yet in the loader chain
     if (aLoaderStatus.addVESID (aVESID).isFailure ())
     {
+      // This is a circular dependency
       aErrorList.add (SingleError.builderError ()
                                  .errorText ("The VESID '" +
                                              aVESID.getAsSingleID () +