Mercurial > pidgin3 / changeset

--- a/libpurple/accountopt.h	Fri Sep 14 08:40:06 2007 +0000
+++ b/libpurple/accountopt.h	Fri Sep 14 13:19:08 2007 +0000
@@ -49,8 +49,10 @@
 
 	} default_value;
 
-	gboolean masked;
-
+	gboolean masked;        /**< Whether the value entered should be
+	                         *   obscured from view (for passwords and
+	                         *   similar options)
+	                         */
 } PurpleAccountOption;
 
 /**
@@ -184,10 +186,12 @@
 											const char *value);
 
 /**
- * Sets the masking for an account option.
+ * Sets the masking for an account option. Setting this to %TRUE acts
+ * as a hint to the UI that the option's value should be obscured from
+ * view, like a password.
  *
  * @param option The account option.
- * @param masked  The masking.
+ * @param masked The masking.
  */
 void
 purple_account_option_set_masked(PurpleAccountOption *option, gboolean masked);
@@ -282,11 +286,13 @@
 	const PurpleAccountOption *option);
 
 /**
- * Returns the masking for an account option.
+ * Returns whether an option's value should be masked from view, like a
+ * password.  If so, the UI might display each character of the option
+ * as a '*' (for example).
  *
  * @param option The account option.
  *
- * @return The masking.
+ * @return %TRUE if the option's value should be obscured.
  */
 gboolean
 purple_account_option_get_masked(const PurpleAccountOption *option);