Bug 306966: Convert method comments in nsISecretDecoderRing to doxygen, patch by Jeff Walden <jwalden@mit.edu>, r+sr=darin

netwerk/base/public/nsISecretDecoderRing.idl

@@ -39,37 +39,57 @@
 
 #include "nsISupports.idl"
 
-/* Buffer type - for storing 8-bit octet values */
+/**
+ * Buffer type - for storing 8-bit octet values.
+ */
 [ptr] native buffer(unsigned char);
 
 [scriptable, uuid(0EC80360-075C-11d4-9FD4-00C04F1B83D8)]
 interface nsISecretDecoderRing: nsISupports {
 
-  /* Encrypt a buffer - callable only from C++ */
+  /**
+   * Encrypt a buffer - callable only from C++.
+   *
+   * @return The length of the data in the output buffer.
+   */
   [noscript] long encrypt(in buffer data, in long dataLen, out buffer result);
 
-  /* Decrypt a buffer - callable only from C++ */
+  /**
+   * Decrypt a buffer - callable only from C++.
+   *
+   * @return The length of the data in the output buffer.
+   */
   [noscript] long decrypt(in buffer data, in long dataLen, out buffer result);
 
-  /* Encrypt nul-terminated string to BASE64 output */
+  /**
+   * Encrypt nul-terminated string to BASE64 output.
+   */
   string encryptString(in string text);
 
-  /* Decrypt BASE64 input to nul-terminated string output */
-  /* There is no check for embedded nul values in the decrypted output */
+  /**
+   * Decrypt BASE64 input to nul-terminated string output.  There is
+   * no check for embedded nul values in the decrypted output.
+   */
   string decryptString(in string crypt);
 
-  /* Prompt the user to change the password on the SDR key */
+  /**
+   * Prompt the user to change the password on the SDR key.
+   */
   void changePassword();
 
-  /* Logout of the security device that protects the SDR key */
+  /**
+   * Logout of the security device that protects the SDR key.
+   */
   void logout();
 
-  /* Logout of the security device that protects the SDR key
-     and tear down authenticated objects. */
+  /**
+   * Logout of the security device that protects the SDR key and tear
+   * down authenticated objects.
+   */
   void logoutAndTeardown();
 };
 
-/*
+/**
  * Configuration interface for the Secret Decoder Ring
  *  - this interface allows setting the window that will be
  *    used as parent for dialog windows (such as password prompts)
@@ -78,5 +98,3 @@ interface nsISecretDecoderRing: nsISupports {
 interface nsISecretDecoderRingConfig: nsISupports {
   void setWindow(in nsISupports w);
 };
-
-