Sprinkle some javadoc

codehaus-plexus · Oct 14, 2024 · 56bcc6c · 56bcc6c
1 parent 1ae037a
commit 56bcc6c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/main/java/org/codehaus/plexus/components/secdispatcher/SecDispatcher.java b/src/main/java/org/codehaus/plexus/components/secdispatcher/SecDispatcher.java
@@ -27,14 +27,15 @@
  */
 public interface SecDispatcher {
     /**
-     * Attribute that selects a dispatcher.
+     * Attribute that selects a dispatcher. If not present in {@link #encrypt(String, Map)} attributes, the
+     * configured "default dispatcher" is used.
      *
      * @see #availableDispatchers()
      */
     String DISPATCHER_NAME_ATTR = "name";
 
     /**
-     * Attribute for version that dispatcher should use.
+     * Attribute for version, added by SecDispatcher for possible upgrade path.
      */
     String DISPATCHER_VERSION_ATTR = "version";
 

diff --git a/...a/org/codehaus/plexus/components/secdispatcher/internal/dispatchers/MasterDispatcher.java b/...a/org/codehaus/plexus/components/secdispatcher/internal/dispatchers/MasterDispatcher.java
@@ -42,6 +42,9 @@ public class MasterDispatcher implements Dispatcher, DispatcherMeta {
 
     private static final String CONF_MASTER_CIPHER = "cipher";
     private static final String CONF_MASTER_SOURCE = "source";
+    /**
+     * Attribute holding the Cipher name used to encrypt the password.
+     */
     private static final String MASTER_CIPHER_ATTR = CONF_MASTER_CIPHER;
 
     private final PlexusCipher cipher;