[pulseaudio-discuss] [PATCH] add section about error handling to doxygen documentation

[Peter Meerwald]

From: Peter Meerwald <p.meerwald at bct-electronic.com>

---
 src/pulse/pulseaudio.h |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/src/pulse/pulseaudio.h b/src/pulse/pulseaudio.h
index bb71772..a368018 100644
--- a/src/pulse/pulseaudio.h
+++ b/src/pulse/pulseaudio.h
@@ -105,6 +105,14 @@
  * to make sure event objects are not manipulated when any other code is
  * using the main loop.
  *
+ * \section error_sec Error Handling
+ *
+ * The PulseAudio API indicates error conditions by returning an integer
+ * value -1 or a NULL pointer. On success, an integer value 0 or a valid
+ * pointer is returned. Certain function provide an optional error code
+ * (see #pa_error_code) which can be turned into a human readable message
+ * using pa_strerror().
+ *
  * \section pkgconfig pkg-config
  *
  * The PulseAudio libraries provide pkg-config snippets for the different
-- 
1.7.4.1