pidgin: a761563b: Correct and clarify some documentation

[markdoliner at pidgin.im]

----------------------------------------------------------------------
Revision: a761563b9d1cddc4d3fee3791527a2fc5b2739d4
Parent:   35a0af5567b9733fe8a424d50b4e74e088b3a82d
Author:   markdoliner at pidgin.im
Date:     08/06/10 13:20:40
Branch:   im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/a761563b9d1cddc4d3fee3791527a2fc5b2739d4

Changelog: 

Correct and clarify some documentation

Changes against parent 35a0af5567b9733fe8a424d50b4e74e088b3a82d

  patched  libpurple/debug.h

-------------- next part --------------
============================================================
--- libpurple/debug.h	17925ca43f7aa7b19914be5b1093f97ff3d99ac2
+++ libpurple/debug.h	3ba4c16eaf446f6ff5b933318195e8c12ea17ea7
@@ -176,20 +176,24 @@ gboolean purple_debug_is_verbose(void);
 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
  */