From: Jaroslav Kysela Date: Wed, 18 Jul 2001 12:17:11 +0000 (+0000) Subject: More documentation updates. X-Git-Tag: v1.0.3~733 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=0d9a5d0e597b1f6c66015f3e2cba789e90a9a122;p=alsa-lib.git More documentation updates. --- diff --git a/include/header.h b/include/header.h index e8275531..44114969 100644 --- 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 * \author Abramo Bagnara * \author Takashi Iwai diff --git a/src/async.c b/src/async.c index 6d0e6541..d1c9e2f9 100644 --- a/src/async.c +++ b/src/async.c @@ -1,5 +1,6 @@ /** * \file async.c + * \brief Async notification helpers * \author Abramo Bagnara * \date 2001 */ diff --git a/src/conf.c b/src/conf.c index b5bde9cc..e2144c0f 100644 --- a/src/conf.c +++ b/src/conf.c @@ -1,3 +1,12 @@ +/** + * \file conf.c + * \brief Configuration helper functions + * \author Abramo Bagnara + * \author Jaroslav Kysela + * \date 2000-2001 + * + * Generic stdio-like input interface + */ /* * Configuration helper functions * Copyright (c) 2000 by Abramo Bagnara , @@ -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 b03a92c6..f450cd8d 100644 --- 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 * \date 1998-2001 */ /* - * Control Interface - main file + * Soundcard Operations - main file * Copyright (c) 1998 by Jaroslav Kysela * * diff --git a/src/control/control.c b/src/control/control.c index 91c047fd..5f4abc8f 100644 --- 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 * \date 2000 * diff --git a/src/control/hcontrol.c b/src/control/hcontrol.c index c3b5637a..1eae4699 100644 --- 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 * \author Abramo Bagnara * \date 2000 diff --git a/src/control/setup.c b/src/control/setup.c index e7acc9a9..f2d0d778 100644 --- 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 * \author Jaroslav Kysela * \date 2001 diff --git a/src/error.c b/src/error.c index 160c970c..7c62ca2a 100644 --- a/src/error.c +++ b/src/error.c @@ -1,5 +1,9 @@ /** * \file error.c + * \brief Error code handling routines + * \author Jaroslav Kysela + * \date 1998-2001 + * * Error code handling routines. */ /* diff --git a/src/hwdep/hwdep.c b/src/hwdep/hwdep.c index b5dcf140..77881803 100644 --- 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 * \date 2000-2001 * diff --git a/src/input.c b/src/input.c index 40c3c40f..0b7b083c 100644 --- a/src/input.c +++ b/src/input.c @@ -1,5 +1,6 @@ /** * \file input.c + * \brief Generic stdio-like input interface * \author Abramo Bagnara * \date 2000 * diff --git a/src/instr/fm.c b/src/instr/fm.c index e272c168..19cd493a 100644 --- 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 * \date 2000-2001 */ diff --git a/src/instr/iwffff.c b/src/instr/iwffff.c index de2a0658..59b6a2da 100644 --- 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 * \date 1999-2001 */ diff --git a/src/instr/simple.c b/src/instr/simple.c index a2d4009e..2a2c8e4a 100644 --- 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 * \date 1999-2001 */ diff --git a/src/mixer/mixer.c b/src/mixer/mixer.c index a28c2de2..0053aed8 100644 --- a/src/mixer/mixer.c +++ b/src/mixer/mixer.c @@ -1,5 +1,6 @@ /** * \file mixer/mixer.c + * \brief Mixer Interface * \author Jaroslav Kysela * \author Abramo Bagnara * \date 2001 diff --git a/src/mixer/simple.c b/src/mixer/simple.c index e3ad773c..727da83e 100644 --- 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 * \author Abramo Bagnara * \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 118ae276..3caf9173 100644 --- a/src/output.c +++ b/src/output.c @@ -1,5 +1,6 @@ /** * \file output.c + * \brief Generic stdio-like output interface * \author Abramo Bagnara * \date 2000 * diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c index d8deac90..d0662279 100644 --- a/src/pcm/pcm.c +++ b/src/pcm/pcm.c @@ -1,5 +1,6 @@ /** * \file pcm/pcm.c + * \brief PCM Interface * \author Jaroslav Kysela * \author Abramo Bagnara * \date 2000-2001 diff --git a/src/pcm/pcm_meter.c b/src/pcm/pcm_meter.c index e5d7e35d..0b1c49d9 100644 --- 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 * \date 2001 * diff --git a/src/rawmidi/rawmidi.c b/src/rawmidi/rawmidi.c index 54451a9d..5ce2356a 100644 --- a/src/rawmidi/rawmidi.c +++ b/src/rawmidi/rawmidi.c @@ -1,5 +1,6 @@ /** * \file rawmidi/rawmidi.c + * \brief RawMidi Interface * \author Jaroslav Kysela * \author Abramo Bagnara * \date 2000-2001 diff --git a/src/seq/seq.c b/src/seq/seq.c index a759d258..3dad6600 100644 --- a/src/seq/seq.c +++ b/src/seq/seq.c @@ -1,5 +1,6 @@ /** * \file seq/seq.c + * \brief Sequencer Interface * \author Jaroslav Kysela * \author Abramo Bagnara * \author Takashi Iwai diff --git a/src/seq/seq_event.c b/src/seq/seq_event.c index 17cd6008..5f6c6ee7 100644 --- 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 * \date 2001 */ diff --git a/src/seq/seq_midi_event.c b/src/seq/seq_midi_event.c index 125aff9f..726cbf90 100644 --- 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 * \author Jaroslav Kysela * \date 2000-2001 diff --git a/src/timer/timer.c b/src/timer/timer.c index edfa5c08..5389b3c3 100644 --- a/src/timer/timer.c +++ b/src/timer/timer.c @@ -1,5 +1,6 @@ /* * \file timer/timer.c + * \brief Timer Interface * \author Jaroslav Kysela * \date 1998-2001 *