]> git.alsa-project.org Git - alsa-lib.git/commitdiff
fixed documents to process properly via doxygen.
authorTakashi Iwai <tiwai@suse.de>
Mon, 24 May 2004 14:57:47 +0000 (14:57 +0000)
committerTakashi Iwai <tiwai@suse.de>
Mon, 24 May 2004 14:57:47 +0000 (14:57 +0000)
doc/doxygen.cfg
doc/index.doxygen
src/hwdep/hwdep.c
src/mixer/mixer.c
src/mixer/simple.c
src/pcm/pcm_share.c
src/timer/timer.c
src/timer/timer_query.c

index ef1a05756b5056acc004b35531f18175bc4d8912..c82f1fc84c4ebb3983932aaf4ecc5ca66187cce0 100644 (file)
@@ -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 \
index 0e0face8daefd47c61003a26f2c038678d4faac9..f8740be06355eaf2909ede4f9bdb136f4401dab1 100644 (file)
@@ -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.
index 5f16c9f69d7ce1377c67872cb3e5829c80977b1c..43d96265a995d91fe198b53fcd774cb435f1b316 100644 (file)
@@ -1,4 +1,4 @@
-/*
+/**
  * \file hwdep/hwdep.c
  * \brief HwDep Interface (hardware dependent)
  * \author Jaroslav Kysela <perex@suse.cz>
index 8723a38eb18f3eb637ad94a50a7434fa5a07b7f1..624912018553e2f963c644db0b22a71f5340d166 100644 (file)
  *
  */
 
+/*! \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>
index 2e99e74ce722d86397da88d7f24e774d63d0e671..1ce12d1b5633d80916b4188a80805b08f6fb5085 100644 (file)
@@ -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)
 {
index deecbcbc8fec3dba3775baab9c2a324f3fed8678..46fe4262341833c98e1e34de706078768828964b 100644 (file)
@@ -1,4 +1,4 @@
-/*
+/**
  * \file pcm/pcm_share.c
  * \ingroup PCM_Plugins
  * \brief PCM Share Plugin Interface
index efb1ba47d2d28184b11d321973eac1e631b1bd97..5bd86cd2bacf3501a4f76d7d81b888b5efe0b0c3 100644 (file)
@@ -1,4 +1,4 @@
-/*
+/**
  * \file timer/timer.c
  * \brief Timer Interface
  * \author Jaroslav Kysela <perex@suse.cz>
index 2e3096f28ca4f79977d1f3ed913d18044fe5d00c..44dd13dfff44b5cc042c1dfa53df9d431259810b 100644 (file)
@@ -1,4 +1,4 @@
-/*
+/**
  * \file timer/timer_query.c
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 2001