From 918a6ee99820a09620599575e951cb0e5530d82b Mon Sep 17 00:00:00 2001
From: Michi Henning <michi@zeroc.com>
Date: Wed, 10 Jun 2009 16:06:51 +1000
Subject: Bug 3502 - Improve javadoc support in Eclipse. Added more comments.
 Source files are now added to Ice.jar and Freeze.jar.

---
 java/src/IceSSL/PasswordCallback.java | 43 +++++++++++++++++++++--------------
 1 file changed, 26 insertions(+), 17 deletions(-)

(limited to 'java/src/IceSSL/PasswordCallback.java')

diff --git a/java/src/IceSSL/PasswordCallback.java b/java/src/IceSSL/PasswordCallback.java
index be1e9dff4cd..9fc76d6e59f 100644
--- a/java/src/IceSSL/PasswordCallback.java
+++ b/java/src/IceSSL/PasswordCallback.java
@@ -9,28 +9,37 @@
 
 package IceSSL;
 
-//
-// A password callback is an alternate way of supplying the plug-in with
-// passwords that avoids using plaintext configuration properties.
-//
+/**
+ * A password callback is an alternate way to supply the plug-in with
+ * passwords; this avoids using plain text configuration properties.
+ **/
 public interface PasswordCallback
 {
-    //
-    // Obtain the password for the key. If an alias was selected using
-    // the IceSSL.Alias property, the value of the property is provided.
-    // The return value must not be null.
-    //
+    /**
+     * Returns the password for the key. If an alias was selected
+     * by setting the <code>IceSSL.Alias</code> property, <code>alias</code>
+     * contains the property's value.
+     *
+     * @param alias The value of the property <code>IceSSL.Alias</code>, if that
+     * property is set; <code>null</code>, otherwise.
+     * @return The password for the key. The return value must not be <code>null</code>.
+     * 
+     **/
     char[] getPassword(String alias);
 
-    //
-    // Obtain the password for validating the truststore. Return null
-    // to skip truststore validation.
-    //
+    /**
+     * Returns the password for validating the truststore.
+     *
+     * @return The password. To skip truststore validation,
+     * return <code>null</code>.
+     **/
     char[] getTruststorePassword();
 
-    //
-    // Obtain the password for validating the keystore. Return null
-    // to skip keystore validation.
-    //
+    /**
+     * Returns the password for validating the keystore.
+     *
+     * @return The password. To skip keystore validation,
+     * return <code>null</code>.
+     **/
     char[] getKeystorePassword();
 }
-- 
cgit v1.2.3