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.

diff --git a/src/pulse/channelmap.h b/src/pulse/channelmap.h
index d1d5c8b3255bc3e3a6ae9f27a90596b98e1d1025..a6b93ddcd70e256dd196def1c823f5f27e7c24f6 100644 (file)
--- a/src/pulse/channelmap.h
+++ b/src/pulse/channelmap.h
@@ -65,7 +65,10 @@
  */
 
 /** \file
- * Constants and routines for channel mapping handling */
+ * Constants and routines for channel mapping handling
+ *
+ * See also \subpage channelmap
+ */
 
 PA_C_DECL_BEGIN
 

diff --git a/src/pulse/context.h b/src/pulse/context.h
index 6ac8ee566bd90748992e076fcaf5d418a4f721c1..7686456deb941b519f8b96ad14614cc5262021d4 100644 (file)
--- a/src/pulse/context.h
+++ b/src/pulse/context.h
@@ -145,7 +145,10 @@
 /** \file
  * Connection contexts for asynchrononous communication with a
  * 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
 

diff --git a/src/pulse/glib-mainloop.h b/src/pulse/glib-mainloop.h
index fd173d018ed74fad6cf6d3d0ea90fb6dd6f4cc9b..805d7460da12b67bd0ae5cb18ba0477f9c39cb97 100644 (file)
--- a/src/pulse/glib-mainloop.h
+++ b/src/pulse/glib-mainloop.h
@@ -41,7 +41,10 @@
  */
 
 /** \file
- * GLIB main loop support */
+ * GLIB main loop support
+ *
+ * See also \subpage glib-mainloop
+ */
 
 PA_C_DECL_BEGIN
 

diff --git a/src/pulse/introspect.h b/src/pulse/introspect.h
index 539112f7644b6fd6499d45f25dd1561291418803..56dd70793fafeac66c830d83dfe425c99128bdb0 100644 (file)
--- a/src/pulse/introspect.h
+++ b/src/pulse/introspect.h
@@ -187,6 +187,8 @@
 /** \file
  *
  * Routines for daemon introspection.
+ *
+ * See also \subpage introspect
  */
 
 PA_C_DECL_BEGIN

diff --git a/src/pulse/mainloop.h b/src/pulse/mainloop.h
index 213f91d8490f2f9c9a67a1a2459a76e8eef14380..19b17fa6321ae321420c02571b9dc3bd46b25656 100644 (file)
--- a/src/pulse/mainloop.h
+++ b/src/pulse/mainloop.h
@@ -71,7 +71,10 @@ struct pollfd;
  * function. Using the routines defined herein you may create a simple
  * main loop supporting the generic main loop abstraction layer as
  * 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 */
 typedef struct pa_mainloop pa_mainloop;

diff --git a/src/pulse/sample.h b/src/pulse/sample.h
index 7a4a55a0f83d6a86e88096d86b705a684daf2572..c9e6fc4851716e128e806d1b990ac13618b7bf31 100644 (file)
--- a/src/pulse/sample.h
+++ b/src/pulse/sample.h
@@ -105,7 +105,10 @@
  */
 
 /** \file
- * Constants and routines for sample type handling */
+ * Constants and routines for sample type handling
+ *
+ * See also \subpage sample
+ */
 
 PA_C_DECL_BEGIN
 

diff --git a/src/pulse/scache.h b/src/pulse/scache.h
index 31cf7b01c7b9b25c0257f70a6fa3fbbd77eefb17..b4fcbd07975a48409148edd6e51ceb4ef20e935a 100644 (file)
--- a/src/pulse/scache.h
+++ b/src/pulse/scache.h
@@ -74,7 +74,10 @@
  */
 
 /** \file
- * All sample cache related routines */
+ * All sample cache related routines
+ *
+ * See also \subpage scache
+ */
 
 PA_C_DECL_BEGIN
 

diff --git a/src/pulse/simple.h b/src/pulse/simple.h
index df8758b0fe9efedb1dd41e1f877dd3012c40715a..ecffe4fa3b7f4ffcae710837c0c4b5a5275287a9 100644 (file)
--- a/src/pulse/simple.h
+++ b/src/pulse/simple.h
@@ -98,7 +98,10 @@
 /** \file
  * A simple but limited synchronous playback and recording
  * API. This is a synchronous, simplified wrapper around the standard
- * asynchronous API. */
+ * asynchronous API.
+ *
+ * See also \subpage simple
+ */
 
 /** \example pacat-simple.c
  * A simple playback tool using the simple API */

diff --git a/src/pulse/stream.h b/src/pulse/stream.h
index 0985f5b23769099d321bfaac1658a8d9701eb801..256b150707676d3a74de24e6cf91716fb3be5c41 100644 (file)
--- a/src/pulse/stream.h
+++ b/src/pulse/stream.h
@@ -310,7 +310,10 @@
  */
 
 /** \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
 

diff --git a/src/pulse/subscribe.h b/src/pulse/subscribe.h
index 44ed24ae5b48d830444f8fada8ef1fe3bdef1f0f..f1e17ca14ee1618a62020d045d386dcb1362a8aa 100644 (file)
--- a/src/pulse/subscribe.h
+++ b/src/pulse/subscribe.h
@@ -45,7 +45,10 @@
  */
 
 /** \file
- * Daemon introspection event subscription subsystem. */
+ * Daemon introspection event subscription subsystem.
+ *
+ * See also \subpage subscribe
+ */
 
 PA_C_DECL_BEGIN
 

diff --git a/src/pulse/thread-mainloop.h b/src/pulse/thread-mainloop.h
index 1c98d543731d128dfe64460e7edc5e5af0e07731..f911228b8d1153ce23e9b57615f6ee963414320f 100644 (file)
--- a/src/pulse/thread-mainloop.h
+++ b/src/pulse/thread-mainloop.h
@@ -239,7 +239,10 @@ PA_C_DECL_BEGIN
  * A thread based event loop implementation based on pa_mainloop. The
  * event loop is run in a helper thread in the background. A few
  * 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 */
 typedef struct pa_threaded_mainloop pa_threaded_mainloop;

diff --git a/src/pulse/volume.h b/src/pulse/volume.h
index 1c36717ba5751a1c81a52f83132547d73f6116ee..594cf91db16bcb865075fceaef53291eedf2d440 100644 (file)
--- a/src/pulse/volume.h
+++ b/src/pulse/volume.h
@@ -92,7 +92,10 @@
  */
 
 /** \file
- * Constants and routines for volume handling */
+ * Constants and routines for volume handling
+ *
+ * See also \subpage volume
+ */
 
 PA_C_DECL_BEGIN