summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2014-12-27 09:49:37 +0000
committerPhilip Withnall <philip.withnall@collabora.co.uk>2014-12-27 09:49:37 +0000
commitc6fa14f4fe10f04e1b9a4c231caa8054e0c7224d (patch)
tree0510585fbae4770bc76d0f2e2f1853ccd6695e1c
parent8ecd6b89a815856b52d5931dd3a6d90fa9e85757 (diff)
agent: Document G_MESSAGES_DEBUG and NICE_DEBUG
As requested on the mailing list, expand the documentation for nice_debug_enable() to mention them.
-rw-r--r--agent/debug.h14
1 files changed, 12 insertions, 2 deletions
diff --git a/agent/debug.h b/agent/debug.h
index 22c22f6..20816e8 100644
--- a/agent/debug.h
+++ b/agent/debug.h
@@ -75,9 +75,19 @@ G_BEGIN_DECLS
/**
* nice_debug_enable:
- * @with_stun: Also enable stun debugging messages
+ * @with_stun: Also enable STUN debugging messages
*
- * Enables libnice debug output to the terminal
+ * Enables libnice debug output to the terminal. Note that the
+ * `G_MESSAGES_DEBUG` and `NICE_DEBUG` environment variables must be set to the
+ * set of logging domains to print, in order for any output to be printed. Set
+ * them to `all` to print all debugging messages, or any of the following
+ * domains:
+ * - `libnice-stun`
+ * - `libnice-tests`
+ * - `libnice-socket`
+ * - `libnice`
+ * - `libnice-pseudotcp`
+ * - `libnice-pseudotcp-verbose`
*/
void nice_debug_enable (gboolean with_stun);