diff libpurple/accountopt.h @ 23842:7ff461621d77

Correct documentation about list account options to reflect what the key and value of the PurpleKeyValuePair actually represent (based on what Pidgin does with them). (Since the only protocol to use them, silc, uses the same string for the key and the value, no harm came of me having written incorrect documentation last time.)

--- a/libpurple/accountopt.h	Sun Aug 17 10:37:42 2008 +0000
+++ b/libpurple/accountopt.h	Sun Aug 17 11:10:39 2008 +0000
@@ -139,8 +139,10 @@
  * The list passed will be owned by the account option, and the
  * strings inside will be freed automatically.
  *
- * The list is a list of PurpleKeyValuePair items. The key is the ID stored and
- * used internally, and the <tt>(const char *)</tt> value is the label displayed.
+ * The list is a list of #PurpleKeyValuePair items. The key is the label that
+ * should be displayed to the user, and the <tt>(const char *)</tt> value is
+ * the internal ID that should be passed to purple_account_set_string() to
+ * choose that value.
  *
  * @param text      The text of the option.
  * @param pref_name The account preference name for the option.
@@ -304,7 +306,10 @@
  *
  * @param option The account option.
  *
- * @constreturn The list values.
+ * @constreturn A list of #PurpleKeyValuePair, mapping the human-readable
+ *              description of the value to the <tt>(const char *)</tt> that
+ *              should be passed to purple_account_set_string() to set the
+ *              option.
  */
 GList *purple_account_option_get_list(const PurpleAccountOption *option);