More documentation updates.

diff --git a/include/header.h b/include/header.h
index e82755312cd557f6f213bb1d67558ea98d3a059d..44114969714e539252fb5c65ad3dc1f5f724604c 100644 (file)
--- a/include/header.h
+++ b/include/header.h
@@ -1,5 +1,6 @@
 /**
  * \file asoundlib.h
+ * \brief Application interface library for the ALSA driver
  * \author Jaroslav Kysela <perex@suse.cz>
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \author Takashi Iwai <tiwai@suse.de>

diff --git a/src/async.c b/src/async.c
index 6d0e654172422446a64115812565a9997d468ca9..d1c9e2f9d1a36f391cfc9269f34893bb66ab5315 100644 (file)
--- a/src/async.c
+++ b/src/async.c
@@ -1,5 +1,6 @@
 /**
  * \file async.c
+ * \brief Async notification helpers
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2001
  */

diff --git a/src/conf.c b/src/conf.c
index b5bde9cceee0f6b21495fb166be3d428dbd3018c..e2144c0ff9ebcc1193b480d9947be721d270594f 100644 (file)
--- a/src/conf.c
+++ b/src/conf.c
@@ -1,3 +1,12 @@
+/**
+ * \file conf.c
+ * \brief Configuration helper functions
+ * \author Abramo Bagnara <abramo@alsa-project.org>
+ * \author Jaroslav Kysela <perex@suse.cz>
+ * \date 2000-2001
+ *
+ * Generic stdio-like input interface
+ */
 /*
  *  Configuration helper functions
  *  Copyright (c) 2000 by Abramo Bagnara <abramo@alsa-project.org>,
@@ -474,7 +483,7 @@ static int parse_value(snd_config_t **_n, snd_config_t *father, input_t *input,
                free(s);
                return 0;
        }
-       if ((s[0] >= '0' && s[0] <= '9') || s[0] == '-') {
+       if (err == 0 && (s[0] >= '0' && s[0] <= '9') || s[0] == '-') {
                long i;
                errno = 0;
                err = safe_strtol(s, &i);
@@ -948,8 +957,9 @@ static int _snd_config_save_leaves(snd_config_t *config, snd_output_t *out, unsi
 
 /**
  * \brief Substitute one node to another
- * \brief dst Destination node
- * \brief src Source node (invalid after call)
+ * \param dst Destination node
+ * \param src Source node (invalid after call)
+ * \return zero if success, otherwise a negative error code
  */
 int snd_config_substitute(snd_config_t *dst, snd_config_t *src)
 {
@@ -1457,6 +1467,8 @@ int snd_config_save(snd_config_t *config, snd_output_t *out)
  *  *** search macros ***
  */
 
+#ifndef DOC_HIDDEN
+
 #define SND_CONFIG_SEARCH(config, key, result, extra_code) \
 { \
        snd_config_t *n; \
@@ -1573,6 +1585,7 @@ int snd_config_save(snd_config_t *config, snd_output_t *out)
        return 0; \
 }
 
+#endif /* DOC_HIDDEN */
 
 /**
  * \brief Search a node inside a config tree
@@ -1856,6 +1869,14 @@ static int snd_config_hooks(snd_config_t *config, void *private_data)
        return err;
 }
 
+/**
+ * \brief Load configuration from specified files
+ * \param root Configuration root node
+ * \param config Configuration node
+ * \param dst Destination node
+ * \param private_data Private data
+ * \return zero if success, otherwise a negative error code
+ */
 int snd_config_hook_load(snd_config_t *root, snd_config_t *config, snd_config_t **dst, void *private_data)
 {
        snd_config_t *n, *res = NULL;
@@ -1978,8 +1999,18 @@ int snd_config_hook_load(snd_config_t *root, snd_config_t *config, snd_config_t
        return err;
 }
 
+#ifndef DOC_HIDDEN
 int snd_determine_driver(int card, char **driver);
+#endif
 
+/**
+ * \brief Load configuration for all present cards
+ * \param root Configuration root node
+ * \param config Configuration node
+ * \param dst Destination node
+ * \param private_data Private data
+ * \return zero if success, otherwise a negative error code
+ */
 int snd_config_hook_load_for_all_cards(snd_config_t *root, snd_config_t *config, snd_config_t **dst, void *private_data ATTRIBUTE_UNUSED)
 {
        int card = -1, err;
@@ -2201,20 +2232,23 @@ snd_config_t *snd_config_iterator_entry(snd_config_iterator_t iterator)
        return list_entry(iterator, snd_config_t, list);
 }
 
+#ifndef DOC_HIDDEN
 typedef enum _snd_config_walk_pass {
        SND_CONFIG_WALK_PASS_PRE,
        SND_CONFIG_WALK_PASS_POST,
        SND_CONFIG_WALK_PASS_LEAF,
 } snd_config_walk_pass_t;
-
+#endif
 
 /* Return 1 if node needs to be attached to father */
 /* Return 2 if compound is replaced with standard node */
+#ifndef DOC_HIDDEN
 typedef int (*snd_config_walk_callback_t)(snd_config_t *src,
                                          snd_config_t *root,
                                          snd_config_t **dst,
                                          snd_config_walk_pass_t pass,
                                          void *private_data);
+#endif
 
 static int snd_config_walk(snd_config_t *src,
                           snd_config_t *root,

diff --git a/src/control/cards.c b/src/control/cards.c
index b03a92c64530b09946eace21022a3c2fa4bfebea..f450cd8df43ed8bf5fc2b3d28efa1a9d414053d6 100644 (file)
--- a/src/control/cards.c
+++ b/src/control/cards.c
@@ -1,10 +1,11 @@
 /**
  * \file control/cards.c
+ * \brief Basic Soundcard Operations
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 1998-2001
  */
 /*
- *  Control Interface - main file
+ *  Soundcard Operations - main file
  *  Copyright (c) 1998 by Jaroslav Kysela <perex@suse.cz>
  *
  *

diff --git a/src/control/control.c b/src/control/control.c
index 91c047fdc8453a6b658d804061cdd0273b12bcc3..5f4abc8fb7e4271ed8e18c1d37c0b012d5c147b9 100644 (file)
--- a/src/control/control.c
+++ b/src/control/control.c
@@ -1,5 +1,6 @@
 /**
  * \file control/control.c
+ * \brief CTL interface - primitive controls
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2000
  *

diff --git a/src/control/hcontrol.c b/src/control/hcontrol.c
index c3b5637a48b17bfe3711cc6aef0dcdbd16ad1f9a..1eae46990df7092210a10c6facf1c15a46f501bf 100644 (file)
--- a/src/control/hcontrol.c
+++ b/src/control/hcontrol.c
@@ -1,5 +1,6 @@
 /**
  * \file control/hcontrol.c
+ * \brief HCTL Interface - High Level CTL
  * \author Jaroslav Kysela <perex@suse.cz>
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2000

diff --git a/src/control/setup.c b/src/control/setup.c
index e7acc9a975d42ed21e9f2f6281e72f2699627e7c..f2d0d778e3090e98dbe880865ffedb207159d6b9 100644 (file)
--- a/src/control/setup.c
+++ b/src/control/setup.c
@@ -1,5 +1,6 @@
 /**
  * \file control/setup.c
+ * \brief Routines to setup control primitives from configuration
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 2001

diff --git a/src/error.c b/src/error.c
index 160c970c5c01b6d7e7ddc64eff0bc08b36d0fd32..7c62ca2a9ec291ca014b9d6a733d30e29107ba25 100644 (file)
--- a/src/error.c
+++ b/src/error.c
@@ -1,5 +1,9 @@
 /**
  * \file error.c
+ * \brief Error code handling routines
+ * \author Jaroslav Kysela <perex@suse.cz>
+ * \date 1998-2001
+ *
  * Error code handling routines.
  */
 /*

diff --git a/src/hwdep/hwdep.c b/src/hwdep/hwdep.c
index b5dcf140772f4b7910e3739dacc3800acf84c3dd..778818031fa14116a01b00ec07623d1617358dcb 100644 (file)
--- a/src/hwdep/hwdep.c
+++ b/src/hwdep/hwdep.c
@@ -1,5 +1,6 @@
 /*
  * \file hwdep/hwdep.c
+ * \brief HwDep Interface (hardware dependent)
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 2000-2001
  *

diff --git a/src/input.c b/src/input.c
index 40c3c40fc8e567b56843f72be9dd299a094c15fa..0b7b083c1fb4537a318db7514fb5988629df4fe0 100644 (file)
--- a/src/input.c
+++ b/src/input.c
@@ -1,5 +1,6 @@
 /**
  * \file input.c
+ * \brief Generic stdio-like input interface
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2000
  *

diff --git a/src/instr/fm.c b/src/instr/fm.c
index e272c1685a3c63f8117c7277008913315e2edadf..19cd493aa2498d5b34af9d57604d9a526a1422ac 100644 (file)
--- a/src/instr/fm.c
+++ b/src/instr/fm.c
@@ -1,5 +1,6 @@
 /**
  * \file src/instr/fm.c
+ * \brief FM (OPL2/3) Instrument Format Support
  * \author Uros Bizjak <uros@kss-loka.si>
  * \date 2000-2001
  */

diff --git a/src/instr/iwffff.c b/src/instr/iwffff.c
index de2a0658e9e8e49366449b4225c47a64bf29d8c4..59b6a2da23bad3c1e9467335cfcc1befc534d430 100644 (file)
--- a/src/instr/iwffff.c
+++ b/src/instr/iwffff.c
@@ -1,5 +1,6 @@
 /**
  * \file src/instr/iwffff.c
+ * \brief InterWave FFFF Format Support
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 1999-2001
  */

diff --git a/src/instr/simple.c b/src/instr/simple.c
index a2d4009e418d73027cc25ed41d8cf0bf4b021645..2a2c8e4ada7541b561fe22e7a810acccac6bfb36 100644 (file)
--- a/src/instr/simple.c
+++ b/src/instr/simple.c
@@ -1,5 +1,6 @@
 /**
  * \file src/instr/simple.c
+ * \brief Simple Wave Format Support
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 1999-2001
  */

diff --git a/src/mixer/mixer.c b/src/mixer/mixer.c
index a28c2de2f84d5933a2e1c3191c74bbcdcc9e536b..0053aed849a427fc264c1131c27e3614633311df 100644 (file)
--- a/src/mixer/mixer.c
+++ b/src/mixer/mixer.c
@@ -1,5 +1,6 @@
 /**
  * \file mixer/mixer.c
+ * \brief Mixer Interface
  * \author Jaroslav Kysela <perex@suse.cz>
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2001

diff --git a/src/mixer/simple.c b/src/mixer/simple.c
index e3ad773c74d4b3700cc458b0d9f7101221fa1377..727da83ed24a035865284ceb3b53106a268508f1 100644 (file)
--- a/src/mixer/simple.c
+++ b/src/mixer/simple.c
@@ -1,10 +1,11 @@
 /*
  * \file mixer/simple.c
+ * \brief Mixer Simple Element Class Interface
  * \author Jaroslav Kysela <perex@suse.cz>
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2001
  *
- * Mixer simple elements class interface.
+ * Mixer simple element class interface.
  */
 /*
  *  Mixer Interface - simple controls

diff --git a/src/output.c b/src/output.c
index 118ae27606f9b376ff4e6397991e8b2b70e3391d..3caf9173b7d46479b8a90d189be81da5ebd8ea3d 100644 (file)
--- a/src/output.c
+++ b/src/output.c
@@ -1,5 +1,6 @@
 /**
  * \file output.c
+ * \brief Generic stdio-like output interface
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2000
  *

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index d8deac90ebf6d035da7fd64e9c7fd4c4defabe5b..d066227954f5fe644a47f5819607b0b4062bb10d 100644 (file)
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -1,5 +1,6 @@
 /**
  * \file pcm/pcm.c
+ * \brief PCM Interface
  * \author Jaroslav Kysela <perex@suse.cz>
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2000-2001

diff --git a/src/pcm/pcm_meter.c b/src/pcm/pcm_meter.c
index e5d7e35d0a540bbf50e2addd4abd6f1d30d9ba3c..0b1c49d9c2b65002a754f4e6d9779b309991742d 100644 (file)
--- a/src/pcm/pcm_meter.c
+++ b/src/pcm/pcm_meter.c
@@ -1,5 +1,6 @@
 /**
  * \file pcm/pcm_meter.c
+ * \brief Helper functions for #SND_PCM_TYPE_METER PCM scopes
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2001
  *

diff --git a/src/rawmidi/rawmidi.c b/src/rawmidi/rawmidi.c
index 54451a9db9da47d8b9c3f227ec66fe1b75b62efb..5ce2356a2f408fc60f37a7cad5041945947b9fc5 100644 (file)
--- a/src/rawmidi/rawmidi.c
+++ b/src/rawmidi/rawmidi.c
@@ -1,5 +1,6 @@
 /**
  * \file rawmidi/rawmidi.c
+ * \brief RawMidi Interface
  * \author Jaroslav Kysela <perex@suse.cz>
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \date 2000-2001

diff --git a/src/seq/seq.c b/src/seq/seq.c
index a759d25809a94af8a3657ab9eaa904490a9700a8..3dad6600b5c4764804fad1ff407d80a4af8e0dda 100644 (file)
--- a/src/seq/seq.c
+++ b/src/seq/seq.c
@@ -1,5 +1,6 @@
 /**
  * \file seq/seq.c
+ * \brief Sequencer Interface
  * \author Jaroslav Kysela <perex@suse.cz>
  * \author Abramo Bagnara <abramo@alsa-project.org>
  * \author Takashi Iwai <tiwai@suse.de>

diff --git a/src/seq/seq_event.c b/src/seq/seq_event.c
index 17cd6008a510c11d677d4a40244327173afec09a..5f6c6ee755197b6c0360d2bf4021eb0ce0a607d8 100644 (file)
--- a/src/seq/seq_event.c
+++ b/src/seq/seq_event.c
@@ -1,5 +1,6 @@
 /**
  * \file seq/seq_event.c
+ * \brief Sequencer Event Types
  * \author Takashi Iwai <tiwai@suse.de>
  * \date 2001
  */

diff --git a/src/seq/seq_midi_event.c b/src/seq/seq_midi_event.c
index 125aff9f1a7c9bb7119a67b016d340a575c16944..726cbf90ea008233f61a1475a2c9d319b1ac174d 100644 (file)
--- a/src/seq/seq_midi_event.c
+++ b/src/seq/seq_midi_event.c
@@ -1,5 +1,6 @@
 /**
  * \file seq/seq_midi_event.c
+ * \brief MIDI byte <-> sequencer event coder
  * \author Takashi Iwai <tiwai@suse.de>
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 2000-2001

diff --git a/src/timer/timer.c b/src/timer/timer.c
index edfa5c08d152321b8c227e3f6e977aedf71dc118..5389b3c39ecbe327c121d44a91690d14c6d31767 100644 (file)
--- a/src/timer/timer.c
+++ b/src/timer/timer.c
@@ -1,5 +1,6 @@
 /*
  * \file timer/timer.c
+ * \brief Timer Interface
  * \author Jaroslav Kysela <perex@suse.cz>
  * \date 1998-2001
  *