changeset 30331:3f503c81de76

Correct and clarify some documentation
author Mark Doliner <mark@kingant.net>
date Fri, 06 Aug 2010 17:20:40 +0000
parents 5b22fbb5f388
children 9e71e7ddfebc
files libpurple/debug.h
diffstat 1 files changed, 8 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/debug.h	Tue Aug 03 16:33:04 2010 +0000
+++ b/libpurple/debug.h	Fri Aug 06 17:20:40 2010 +0000
@@ -176,20 +176,24 @@
 gboolean purple_debug_is_verbose(void);
 
 /**
- * Enable or disable verbose debugging.  This ordinarily should only be called
+ * Enable or disable unsafe debugging.  This ordinarily should only be called
  * by #purple_debug_init, but there are cases where this can be useful for
  * plugins.
  *
- * @param unsafe  TRUE to enable verbose debugging or FALSE to disable it.
+ * @param unsafe TRUE to enable debug logging of messages that could
+ *        potentially contain passwords and other sensitive information.
+ *        FALSE to disable it.
  *
  * @since 2.6.0
  */
 void purple_debug_set_unsafe(gboolean unsafe);
 
 /**
- * Check if unsafe debugging is enabled.
+ * Check if unsafe debugging is enabled.  Defaults to FALSE.
  *
- * @return TRUE if verbose debugging is enabled, FALSE if it is not.
+ * @return TRUE if the debug logging of all messages is enabled, FALSE
+ *         if messages that could potentially contain passwords and other
+ *         sensitive information are not logged.
  *
  * @since 2.6.0
  */