mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-11-04 13:29:59 -05:00
doxygen: Add 'See also' linking to the overview page
A good many of the header files are broken into a function reference page and an overview page. These changes add a direct link from each function reference page to their overview page if one exists.
This commit is contained in:
parent
f2593da3a3
commit
2c9c908e85
12 changed files with 46 additions and 11 deletions
|
|
@ -65,7 +65,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* Constants and routines for channel mapping handling */
|
* Constants and routines for channel mapping handling
|
||||||
|
*
|
||||||
|
* See also \subpage channelmap
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -145,7 +145,10 @@
|
||||||
/** \file
|
/** \file
|
||||||
* Connection contexts for asynchrononous communication with a
|
* Connection contexts for asynchrononous communication with a
|
||||||
* server. A pa_context object wraps a connection to a PulseAudio
|
* server. A pa_context object wraps a connection to a PulseAudio
|
||||||
* server using its native protocol. */
|
* server using its native protocol.
|
||||||
|
*
|
||||||
|
* See also \subpage async
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -41,7 +41,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* GLIB main loop support */
|
* GLIB main loop support
|
||||||
|
*
|
||||||
|
* See also \subpage glib-mainloop
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -187,6 +187,8 @@
|
||||||
/** \file
|
/** \file
|
||||||
*
|
*
|
||||||
* Routines for daemon introspection.
|
* Routines for daemon introspection.
|
||||||
|
*
|
||||||
|
* See also \subpage introspect
|
||||||
*/
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
|
||||||
|
|
@ -71,7 +71,10 @@ struct pollfd;
|
||||||
* function. Using the routines defined herein you may create a simple
|
* function. Using the routines defined herein you may create a simple
|
||||||
* main loop supporting the generic main loop abstraction layer as
|
* main loop supporting the generic main loop abstraction layer as
|
||||||
* defined in \ref mainloop-api.h. This implementation is thread safe
|
* 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.*/
|
* as long as you access the main loop object from a single thread only.
|
||||||
|
*
|
||||||
|
* See also \subpage mainloop
|
||||||
|
*/
|
||||||
|
|
||||||
/** An opaque main loop object */
|
/** An opaque main loop object */
|
||||||
typedef struct pa_mainloop pa_mainloop;
|
typedef struct pa_mainloop pa_mainloop;
|
||||||
|
|
|
||||||
|
|
@ -105,7 +105,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* Constants and routines for sample type handling */
|
* Constants and routines for sample type handling
|
||||||
|
*
|
||||||
|
* See also \subpage sample
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -74,7 +74,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* All sample cache related routines */
|
* All sample cache related routines
|
||||||
|
*
|
||||||
|
* See also \subpage scache
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -98,7 +98,10 @@
|
||||||
/** \file
|
/** \file
|
||||||
* A simple but limited synchronous playback and recording
|
* A simple but limited synchronous playback and recording
|
||||||
* API. This is a synchronous, simplified wrapper around the standard
|
* API. This is a synchronous, simplified wrapper around the standard
|
||||||
* asynchronous API. */
|
* asynchronous API.
|
||||||
|
*
|
||||||
|
* See also \subpage simple
|
||||||
|
*/
|
||||||
|
|
||||||
/** \example pacat-simple.c
|
/** \example pacat-simple.c
|
||||||
* A simple playback tool using the simple API */
|
* A simple playback tool using the simple API */
|
||||||
|
|
|
||||||
|
|
@ -310,7 +310,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* Audio streams for input, output and sample upload */
|
* Audio streams for input, output and sample upload
|
||||||
|
*
|
||||||
|
* See also \subpage streams
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -45,7 +45,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* Daemon introspection event subscription subsystem. */
|
* Daemon introspection event subscription subsystem.
|
||||||
|
*
|
||||||
|
* See also \subpage subscribe
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -239,7 +239,10 @@ PA_C_DECL_BEGIN
|
||||||
* A thread based event loop implementation based on pa_mainloop. The
|
* A thread based event loop implementation based on pa_mainloop. The
|
||||||
* event loop is run in a helper thread in the background. A few
|
* event loop is run in a helper thread in the background. A few
|
||||||
* synchronization primitives are available to access the objects
|
* synchronization primitives are available to access the objects
|
||||||
* attached to the event loop safely. */
|
* attached to the event loop safely.
|
||||||
|
*
|
||||||
|
* See also \subpage threaded_mainloop
|
||||||
|
*/
|
||||||
|
|
||||||
/** An opaque threaded main loop object */
|
/** An opaque threaded main loop object */
|
||||||
typedef struct pa_threaded_mainloop pa_threaded_mainloop;
|
typedef struct pa_threaded_mainloop pa_threaded_mainloop;
|
||||||
|
|
|
||||||
|
|
@ -92,7 +92,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* Constants and routines for volume handling */
|
* Constants and routines for volume handling
|
||||||
|
*
|
||||||
|
* See also \subpage volume
|
||||||
|
*/
|
||||||
|
|
||||||
PA_C_DECL_BEGIN
|
PA_C_DECL_BEGIN
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue