# 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".
# 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
# 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
# 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
# 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
# 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
PA_C_DECL_BEGIN
-/** \pa_context
+/** \struct pa_context
* An opaque connection context to a daemon */
typedef struct pa_context pa_context;
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;
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;
/** 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;
* 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;
/** 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
PA_C_DECL_BEGIN
-/** \pa_operation
+/** \struct pa_operation
* An asynchronous operation object */
typedef struct pa_operation pa_operation;
* 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
PA_C_DECL_BEGIN
-/** \pa_simple
+/** \struct pa_simple
* An opaque simple connection object */
typedef struct pa_simple pa_simple;
PA_C_DECL_BEGIN
-/** \pa_stream
+/** \struct pa_stream
* An opaque stream for playback or recording */
typedef struct pa_stream pa_stream;