From: Takashi Iwai <tiwai@suse.de>
Date: Mon, 24 May 2004 14:57:47 +0000 (+0000)
Subject: fixed documents to process properly via doxygen.
X-Git-Tag: v1.0.5~4
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=c11a1fc9bebf9c58f308d2479e1a5381611acca1;p=alsa-lib.git

fixed documents to process properly via doxygen.
---

diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
index ef1a0575..c82f1fc8 100644
--- a/doc/doxygen.cfg
+++ b/doc/doxygen.cfg
@@ -60,6 +60,7 @@ INPUT            = index.doxygen \
 		   ../src/pcm/pcm_meter.c \
 		   ../src/pcm/pcm_ladspa.c \
 		   ../src/pcm/pcm_asym.c \
+		   ../src/pcm/pcm_iec958.c \
 		   ../src/pcm/pcm_misc.c \
 		   ../src/rawmidi \
 		   ../src/timer \
diff --git a/doc/index.doxygen b/doc/index.doxygen
index 0e0face8..f8740be0 100644
--- a/doc/index.doxygen
+++ b/doc/index.doxygen
@@ -32,6 +32,7 @@ may be placed in the library code instead of the kernel driver.</P>
 <UL>
   <LI>Page \ref control explains the primitive controls API.
   <LI>Page \ref hcontrol explains the high-level primitive controls API.
+  <LI>Page \ref mixer explains the mixer controls API.
   <LI>Page \ref pcm explains the design of the PCM (digital audio) API.
   <LI>Page \ref pcm_plugins explains the design of PCM (digital audio) plugins.
   <LI>Page \ref rawmidi explains the design of the RawMidi API.
diff --git a/src/hwdep/hwdep.c b/src/hwdep/hwdep.c
index 5f16c9f6..43d96265 100644
--- a/src/hwdep/hwdep.c
+++ b/src/hwdep/hwdep.c
@@ -1,4 +1,4 @@
-/*
+/**
  * \file hwdep/hwdep.c
  * \brief HwDep Interface (hardware dependent)
  * \author Jaroslav Kysela <perex@suse.cz>
diff --git a/src/mixer/mixer.c b/src/mixer/mixer.c
index 8723a38e..62491201 100644
--- a/src/mixer/mixer.c
+++ b/src/mixer/mixer.c
@@ -30,6 +30,15 @@
  *
  */
 
+/*! \page mixer Mixer interface
+
+<P>Mixer interface is designed to access the abstracted mixer controls.
+This is an abstraction layer over the hcontrol layer.
+
+\section control_general_overview General overview
+
+*/
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
diff --git a/src/mixer/simple.c b/src/mixer/simple.c
index 2e99e74c..1ce12d1b 100644
--- a/src/mixer/simple.c
+++ b/src/mixer/simple.c
@@ -1,4 +1,4 @@
-/*
+/**
  * \file mixer/simple.c
  * \brief Mixer Simple Element Class Interface
  * \author Jaroslav Kysela <perex@suse.cz>
@@ -110,7 +110,7 @@ static struct mixer_name_table {
 	{0, 0},
 };
 
-#endif
+#endif /* !DOC_HIDDEN */
 
 static const char *get_short_name(const char *lname)
 {
diff --git a/src/pcm/pcm_share.c b/src/pcm/pcm_share.c
index deecbcbc..46fe4262 100644
--- a/src/pcm/pcm_share.c
+++ b/src/pcm/pcm_share.c
@@ -1,4 +1,4 @@
-/*
+/**
  * \file pcm/pcm_share.c
  * \ingroup PCM_Plugins
  * \brief PCM Share Plugin Interface
diff --git a/src/timer/timer.c b/src/timer/timer.c
index efb1ba47..5bd86cd2 100644
--- a/src/timer/timer.c
+++ b/src/timer/timer.c
@@ -1,4 +1,4 @@
-/*
+/**
  * \file timer/timer.c
  * \brief Timer Interface
  * \author Jaroslav Kysela <perex@suse.cz>
diff --git a/src/timer/timer_query.c b/src/timer/timer_query.c
index 2e3096f2..44dd13df 100644
--- a/src/timer/timer_query.c
+++ b/src/timer/timer_query.c
@@ -1,4 +1,4 @@
-/*
+/**
  * \file timer/timer_query.c
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 2001