fixed documents to process properly via doxygen.

This commit is contained in:
Takashi Iwai 2004-05-24 14:57:47 +00:00
parent abf04e4cfd
commit c11a1fc9be
8 changed files with 17 additions and 6 deletions

View file

@ -60,6 +60,7 @@ INPUT = index.doxygen \
../src/pcm/pcm_meter.c \ ../src/pcm/pcm_meter.c \
../src/pcm/pcm_ladspa.c \ ../src/pcm/pcm_ladspa.c \
../src/pcm/pcm_asym.c \ ../src/pcm/pcm_asym.c \
../src/pcm/pcm_iec958.c \
../src/pcm/pcm_misc.c \ ../src/pcm/pcm_misc.c \
../src/rawmidi \ ../src/rawmidi \
../src/timer \ ../src/timer \

View file

@ -32,6 +32,7 @@ may be placed in the library code instead of the kernel driver.</P>
<UL> <UL>
<LI>Page \ref control explains the primitive controls API. <LI>Page \ref control explains the primitive controls API.
<LI>Page \ref hcontrol explains the high-level 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 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 pcm_plugins explains the design of PCM (digital audio) plugins.
<LI>Page \ref rawmidi explains the design of the RawMidi API. <LI>Page \ref rawmidi explains the design of the RawMidi API.

View file

@ -1,4 +1,4 @@
/* /**
* \file hwdep/hwdep.c * \file hwdep/hwdep.c
* \brief HwDep Interface (hardware dependent) * \brief HwDep Interface (hardware dependent)
* \author Jaroslav Kysela <perex@suse.cz> * \author Jaroslav Kysela <perex@suse.cz>

View file

@ -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 <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include <unistd.h> #include <unistd.h>

View file

@ -1,4 +1,4 @@
/* /**
* \file mixer/simple.c * \file mixer/simple.c
* \brief Mixer Simple Element Class Interface * \brief Mixer Simple Element Class Interface
* \author Jaroslav Kysela <perex@suse.cz> * \author Jaroslav Kysela <perex@suse.cz>
@ -110,7 +110,7 @@ static struct mixer_name_table {
{0, 0}, {0, 0},
}; };
#endif #endif /* !DOC_HIDDEN */
static const char *get_short_name(const char *lname) static const char *get_short_name(const char *lname)
{ {

View file

@ -1,4 +1,4 @@
/* /**
* \file pcm/pcm_share.c * \file pcm/pcm_share.c
* \ingroup PCM_Plugins * \ingroup PCM_Plugins
* \brief PCM Share Plugin Interface * \brief PCM Share Plugin Interface

View file

@ -1,4 +1,4 @@
/* /**
* \file timer/timer.c * \file timer/timer.c
* \brief Timer Interface * \brief Timer Interface
* \author Jaroslav Kysela <perex@suse.cz> * \author Jaroslav Kysela <perex@suse.cz>

View file

@ -1,4 +1,4 @@
/* /**
* \file timer/timer_query.c * \file timer/timer_query.c
* \author Jaroslav Kysela <perex@suse.cz> * \author Jaroslav Kysela <perex@suse.cz>
* \date 2001 * \date 2001