fix doxygen

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@498 fefdeb5f-60dc-0310-8127-8f9354f1896f

diff --git a/doxygen/doxygen.conf.in b/doxygen/doxygen.conf.in
index c0e122e..fcda219 100644 (file)
--- a/doxygen/doxygen.conf.in
+++ b/doxygen/doxygen.conf.in
@@ -170,7 +170,7 @@ DISTRIBUTE_GROUP_DOC   = NO
 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
 # Doxygen uses this value to replace tabs by spaces in code fragments.
 
-TAB_SIZE               = 8
+TAB_SIZE               = 4
 
 # This tag can be used to specify a number of aliases that acts 
 # as commands in the documentation. An alias has the form "name=value". 
@@ -417,7 +417,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = ../polyp/polyplib-context.h ../polyp/polyplib-stream.h ../polyp/polyplib.h ../polyp/sample.h ../polyp/polyplib-def.h ../polyp/polyplib-subscribe.h ../polyp/polyplib-introspect.h ../polyp/polyplib-scache.h ../polyp/mainloop-api.h ../polyp/cdecl.h ../polyp/glib-mainloop.h ../polyp/mainloop.h ../polyp/mainloop-signal.h ../polyp/polyplib-error.h ../polyp/polyplib-operation.h ../polyp/polyplib-simple.h ../polyp/polyplib-version.h
+INPUT                  = ../src/polyp/context.h ../src/polyp/stream.h ../src/polyp/polypaudio.h ../src/polyp/sample.h ../src/polyp/def.h ../src/polyp/subscribe.h ../src/polyp/introspect.h ../src/polyp/scache.h ../src/polyp/mainloop-api.h ../src/polyp/cdecl.h ../src/polyp/glib-mainloop.h ../src/polyp/mainloop.h ../src/polyp/mainloop-signal.h ../src/polyp/error.h ../src/polyp/operation.h ../src/polyp/simple.h ../src/polyp/version.h ../src/polyp/volume.h ../src/polyp/channelmap.h
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -455,7 +455,7 @@ EXCLUDE_PATTERNS       =
 # directories that contain example code fragments that are included (see 
 # the \include command).
 
-EXAMPLE_PATH           = ../polyp/
+EXAMPLE_PATH           = ../src/utils ../src/tests
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -550,7 +550,7 @@ VERBATIM_HEADERS       = YES
 # of all compounds will be generated. Enable this if the project 
 # contains a lot of classes, structs, unions or interfaces.
 
-ALPHABETICAL_INDEX     = NO
+ALPHABETICAL_INDEX     = YES
 
 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
@@ -563,7 +563,7 @@ COLS_IN_ALPHA_INDEX    = 5
 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
 # should be ignored while generating the index headers.
 
-IGNORE_PREFIX          = 
+IGNORE_PREFIX          = pa_ PA_
 
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
@@ -660,7 +660,7 @@ DISABLE_INDEX          = NO
 # This tag can be used to set the number of enum values (range [1..20]) 
 # that doxygen will group on one line in the generated HTML documentation.
 
-ENUM_VALUES_PER_LINE   = 4
+ENUM_VALUES_PER_LINE   = 1
 
 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
 # generated containing a tree-like index structure (just like the one that 

diff --git a/src/polyp/context.h b/src/polyp/context.h
index 216d7d8..4efd515 100644 (file)
--- 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 b4815ed..e052cff 100644 (file)
--- 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 91ee411..7bc7522 100644 (file)
--- 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 76065b2..0291f42 100644 (file)
--- 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 691f8c5..eeb2388 100644 (file)
--- 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 6a24d64..d286b0c 100644 (file)
--- 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 c6014bb..c81fdfd 100644 (file)
--- 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 afb25c8..1a13900 100644 (file)
--- 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 e2cab19..e20cfdd 100644 (file)
--- 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;