From 2e9c38aec11fb1e8275396bbf7f669b5213ba025 Mon Sep 17 00:00:00 2001
From: David Fries <david@fries.net>
Date: Sun, 3 Oct 2010 13:41:27 -0500
Subject: 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.
---
 src/pulse/channelmap.h      | 5 ++++-
 src/pulse/context.h         | 5 ++++-
 src/pulse/glib-mainloop.h   | 5 ++++-
 src/pulse/introspect.h      | 2 ++
 src/pulse/mainloop.h        | 5 ++++-
 src/pulse/sample.h          | 5 ++++-
 src/pulse/scache.h          | 5 ++++-
 src/pulse/simple.h          | 5 ++++-
 src/pulse/stream.h          | 5 ++++-
 src/pulse/subscribe.h       | 5 ++++-
 src/pulse/thread-mainloop.h | 5 ++++-
 src/pulse/volume.h          | 5 ++++-
 12 files changed, 46 insertions(+), 11 deletions(-)

(limited to 'src')

diff --git a/src/pulse/channelmap.h b/src/pulse/channelmap.h
index d1d5c8b3..a6b93ddc 100644
--- 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 6ac8ee56..7686456d 100644
--- 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 fd173d01..805d7460 100644
--- 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 539112f7..56dd7079 100644
--- 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 213f91d8..19b17fa6 100644
--- 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 7a4a55a0..c9e6fc48 100644
--- 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 31cf7b01..b4fcbd07 100644
--- 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 df8758b0..ecffe4fa 100644
--- 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 0985f5b2..256b1507 100644
--- 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 44ed24ae..f1e17ca1 100644
--- 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 1c98d543..f911228b 100644
--- 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 1c36717b..594cf91d 100644
--- 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
 
-- 
cgit