From b9513089f57d4ee692c12d911823e6f8f1cc6129 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 17 Feb 2006 00:11:54 +0000 Subject: fix doxygen git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@498 fefdeb5f-60dc-0310-8127-8f9354f1896f --- src/polyp/context.h | 2 +- src/polyp/glib-mainloop.h | 2 +- src/polyp/mainloop-api.h | 6 +++--- src/polyp/mainloop-signal.h | 2 +- src/polyp/mainloop.h | 3 +-- src/polyp/operation.h | 2 +- src/polyp/polypaudio.h | 4 ++-- src/polyp/simple.h | 2 +- src/polyp/stream.h | 2 +- 9 files changed, 12 insertions(+), 13 deletions(-) (limited to 'src') diff --git a/src/polyp/context.h b/src/polyp/context.h index 216d7d87..4efd5156 100644 --- a/src/polyp/context.h +++ b/src/polyp/context.h @@ -49,7 +49,7 @@ PA_C_DECL_BEGIN -/** \pa_context +/** \struct pa_context * An opaque connection context to a daemon */ typedef struct pa_context pa_context; diff --git a/src/polyp/glib-mainloop.h b/src/polyp/glib-mainloop.h index b4815ed9..e052cff3 100644 --- a/src/polyp/glib-mainloop.h +++ b/src/polyp/glib-mainloop.h @@ -32,7 +32,7 @@ PA_C_DECL_BEGIN -/** \pa_glib_mainloop +/** \struct pa_glib_mainloop * An opaque GLIB main loop object */ typedef struct pa_glib_mainloop pa_glib_mainloop; diff --git a/src/polyp/mainloop-api.h b/src/polyp/mainloop-api.h index 91ee4111..7bc7522c 100644 --- a/src/polyp/mainloop-api.h +++ b/src/polyp/mainloop-api.h @@ -53,15 +53,15 @@ typedef enum pa_io_event_flags { PA_IO_EVENT_ERROR = 8 /**< Error event */ } pa_io_event_flags_t; -/** \pa_io_event +/** \struct pa_io_event * An opaque IO event source object */ typedef struct pa_io_event pa_io_event; -/** \pa_defer_event +/** \struct pa_defer_event * An opaque deferred event source object. Events of this type are triggered once in every main loop iteration */ typedef struct pa_defer_event pa_defer_event; -/** \pa_time_event +/** \struct pa_time_event * An opaque timer event source object */ typedef struct pa_time_event pa_time_event; diff --git a/src/polyp/mainloop-signal.h b/src/polyp/mainloop-signal.h index 76065b22..0291f426 100644 --- a/src/polyp/mainloop-signal.h +++ b/src/polyp/mainloop-signal.h @@ -42,7 +42,7 @@ int pa_signal_init(pa_mainloop_api *api); /** Cleanup the signal subsystem */ void pa_signal_done(void); -/** \pa_signal_event +/** \struct pa_signal_event * An opaque UNIX signal event source object */ typedef struct pa_signal_event pa_signal_event; diff --git a/src/polyp/mainloop.h b/src/polyp/mainloop.h index 691f8c50..eeb23884 100644 --- a/src/polyp/mainloop.h +++ b/src/polyp/mainloop.h @@ -35,7 +35,7 @@ PA_C_DECL_BEGIN * defined in \ref mainloop-api.h. This implementation is thread safe * as long as you access the main loop object from a single thread only.*/ -/** \pa_mainloop +/** \struct pa_mainloop * An opaque main loop object */ typedef struct pa_mainloop pa_mainloop; @@ -46,7 +46,6 @@ pa_mainloop *pa_mainloop_new(void); /** Free a main loop object */ void pa_mainloop_free(pa_mainloop* m); - /** Prepare for a single iteration of the main loop. Returns a negative value on error or exit request. timeout specifies a maximum timeout for the subsequent poll, or -1 for blocking behaviour. Defer events are also dispatched when this diff --git a/src/polyp/operation.h b/src/polyp/operation.h index 6a24d649..d286b0c1 100644 --- a/src/polyp/operation.h +++ b/src/polyp/operation.h @@ -30,7 +30,7 @@ PA_C_DECL_BEGIN -/** \pa_operation +/** \struct pa_operation * An asynchronous operation object */ typedef struct pa_operation pa_operation; diff --git a/src/polyp/polypaudio.h b/src/polyp/polypaudio.h index c6014bbb..c81fdfdb 100644 --- a/src/polyp/polypaudio.h +++ b/src/polyp/polypaudio.h @@ -70,8 +70,8 @@ * described in \ref mainloop-api.h. Two distinct implementations are * available: * - * \li \ref mainloop.h: a minimal but fast implementation based on poll() - * \li \ref glib-mainloop.h: a wrapper around GLIB's main loop + * \li \ref mainloop.h : a minimal but fast implementation based on poll() + * \li \ref glib-mainloop.h : a wrapper around GLIB's main loop * * UNIX signals may be hooked to a main loop using the functions from * \ref mainloop-signal.h diff --git a/src/polyp/simple.h b/src/polyp/simple.h index afb25c8e..1a139005 100644 --- a/src/polyp/simple.h +++ b/src/polyp/simple.h @@ -41,7 +41,7 @@ PA_C_DECL_BEGIN -/** \pa_simple +/** \struct pa_simple * An opaque simple connection object */ typedef struct pa_simple pa_simple; diff --git a/src/polyp/stream.h b/src/polyp/stream.h index e2cab19e..e20cfdd4 100644 --- a/src/polyp/stream.h +++ b/src/polyp/stream.h @@ -36,7 +36,7 @@ PA_C_DECL_BEGIN -/** \pa_stream +/** \struct pa_stream * An opaque stream for playback or recording */ typedef struct pa_stream pa_stream; -- cgit