From df8ad5d18fe67b93393fb6f81d7598a95d021680 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 27 Jan 2009 02:37:13 +0100
Subject: add a few missing doxygen comments

---
 src/pulse/gccmacro.h        |  4 ++++
 src/pulse/mainloop-signal.h |  2 ++
 src/pulse/proplist.h        |  2 +-
 src/pulse/timeval.h         | 12 ++++++++++++
 4 files changed, 19 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/pulse/gccmacro.h b/src/pulse/gccmacro.h
index 0533b109..0b1a1a66 100644
--- a/src/pulse/gccmacro.h
+++ b/src/pulse/gccmacro.h
@@ -22,6 +22,9 @@
   USA.
 ***/
 
+/** \file
+ * GCC attribute macros */
+
 #ifdef __GNUC__
 #define PA_GCC_PRINTF_ATTR(a,b) __attribute__ ((format (printf, a, b)))
 #else
@@ -100,6 +103,7 @@
 #else
 /** Macro for usage of GCC's alloc_size attribute */
 #define PA_GCC_ALLOC_SIZE(x)
+/** Macro for usage of GCC's alloc_size attribute */
 #define PA_GCC_ALLOC_SIZE2(x,y)
 #endif
 #endif
diff --git a/src/pulse/mainloop-signal.h b/src/pulse/mainloop-signal.h
index a6c16f2f..a9e250bc 100644
--- a/src/pulse/mainloop-signal.h
+++ b/src/pulse/mainloop-signal.h
@@ -40,8 +40,10 @@ PA_C_DECL_BEGIN
 /** An opaque UNIX signal event source object */
 typedef struct pa_signal_event pa_signal_event;
 
+/** Callback prototype for signal events */
 typedef void (*pa_signal_cb_t) (pa_mainloop_api *api, pa_signal_event*e, int sig, void *userdata);
 
+/** Destroy callback prototype for signal events */
 typedef void (*pa_signal_destroy_cb_t) (pa_mainloop_api *api, pa_signal_event*e, void *userdata);
 
 /** Initialize the UNIX signal subsystem and bind it to the specified main loop */
diff --git a/src/pulse/proplist.h b/src/pulse/proplist.h
index 984a6566..203a28c5 100644
--- a/src/pulse/proplist.h
+++ b/src/pulse/proplist.h
@@ -162,7 +162,7 @@ int pa_proplist_setf(pa_proplist *p, const char *key, const char *format, ...) P
  * internal copy of the data passed is made. \since 0.9.11 */
 int pa_proplist_set(pa_proplist *p, const char *key, const void *data, size_t nbytes);
 
-/* Return a string entry for the specified key. Will return NULL if
+/** Return a string entry for the specified key. Will return NULL if
  * the data is not valid UTF-8. Will return a NUL-terminated string in
  * an internally allocated buffer. The caller should make a copy of
  * the data before accessing the property list again. \since 0.9.11 */
diff --git a/src/pulse/timeval.h b/src/pulse/timeval.h
index ee398296..2b3faf16 100644
--- a/src/pulse/timeval.h
+++ b/src/pulse/timeval.h
@@ -26,17 +26,29 @@
 #include <pulse/cdecl.h>
 #include <pulse/gccmacro.h>
 #include <pulse/sample.h>
+#include <pulse/version.h>
 
 /** \file
  * Utility functions for handling timeval calculations */
 
 PA_C_DECL_BEGIN
 
+/** The number of milliseconds in a second */
 #define PA_MSEC_PER_SEC ((pa_usec_t) 1000ULL)
+
+/** The number of microseconds in a second */
 #define PA_USEC_PER_SEC ((pa_usec_t) 1000000ULL)
+
+/** The number of nanoseconds in a second */
 #define PA_NSEC_PER_SEC ((pa_usec_t) 1000000000ULL)
+
+/** The number of microseconds in a millisecond */
 #define PA_USEC_PER_MSEC ((pa_usec_t) 1000ULL)
+
+/** The number of nanoseconds in a millisecond */
 #define PA_NSEC_PER_MSEC ((pa_usec_t) 1000000ULL)
+
+/** The number of nanoseconds in a microsecond */
 #define PA_NSEC_PER_USEC ((pa_usec_t) 1000ULL)
 
 struct timeval;
-- 
cgit