[tor-commits] [obfsproxy/master] Document public logging functions.

[nickm at torproject.org]

commit 7efc156ce75de996dd0ff13aa447fba83b7fd528
Author: George Kadianakis <desnacked at riseup.net>
Date:   Wed Jan 18 04:50:36 2012 +0200

    Document public logging functions.
---
 src/util.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/src/util.c b/src/util.c
index 2e84cc6..0ac7811 100644
--- a/src/util.c
+++ b/src/util.c
@@ -551,6 +551,7 @@ logv(int severity, const char *format, va_list ap)
 
 /**** Public logging API. ****/
 
+/** Public function for logging an error and then exiting. */
 void
 log_error(const char *format, ...)
 {
@@ -563,6 +564,7 @@ log_error(const char *format, ...)
   exit(1);
 }
 
+/** Public function for logging a warning. */
 void
 log_warn(const char *format, ...)
 {
@@ -574,6 +576,7 @@ log_warn(const char *format, ...)
   va_end(ap);
 }
 
+/** Public function for logging an informative message. */
 void
 log_info(const char *format, ...)
 {
@@ -585,6 +588,7 @@ log_info(const char *format, ...)
   va_end(ap);
 }
 
+/** Public function for logging a debugging message. */
 void
 log_debug(const char *format, ...)
 {
@@ -596,6 +600,8 @@ log_debug(const char *format, ...)
   va_end(ap);
 }
 
+/** Public function for logging a debugging message, given a format
+    string in <b>format</b>, and a va_list <b>ap</b>. */
 void
 log_debug_raw(const char *format, va_list ap)
 {