mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-10-29 05:40:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Changes against latest doxygen

Browse source
This commit is contained in:
Jaroslav Kysela 2002-02-04 11:18:39 +00:00
parent 5dc9be757c
commit a92f910569
8 changed files with 99 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/doxygen.cfg
View file

@ -87,6 +87,9 @@ SHOW_INCLUDE_FILES = NO
JAVADOC_AUTOBRIEF = NO
INHERIT_DOCS = YES
ENABLED_SECTIONS = ""
PREDEFINED = PIC "DOC_HIDDEN"
PREDEFINED = DOXYGEN PIC "DOC_HIDDEN"
OPTIMIZE_OUTPUT_FOR_C = YES # doxygen 1.2.6 option
#INPUT_FILTER = inputfilter
#FILTER_SOURCE_FILES = YES

42
include/seq_event.h
View file

@ -379,14 +379,14 @@ typedef struct snd_seq_ev_sample_control {
unsigned char channel; /**< channel */
unsigned char unused[3]; /**< reserved */
union {
snd_seq_ev_sample_t sample;
snd_seq_ev_cluster_t cluster;
snd_seq_position_t position;
snd_seq_stop_mode_t stop_mode;
snd_seq_frequency_t frequency;
snd_seq_ev_volume_t volume;
snd_seq_ev_loop_t loop;
unsigned char raw8[8];
snd_seq_ev_sample_t sample; /**< sample number */
snd_seq_ev_cluster_t cluster; /**< cluster number */
snd_seq_position_t position; /**< position */
snd_seq_stop_mode_t stop_mode; /**< stop mode */
snd_seq_frequency_t frequency; /**< frequency */
snd_seq_ev_volume_t volume; /**< volume */
snd_seq_ev_loop_t loop; /**< loop control */
unsigned char raw8[8]; /**< raw 8-bit */
} param; /**< control parameters */
} snd_seq_ev_sample_control_t;
@ -437,19 +437,19 @@ typedef struct snd_seq_event {
snd_seq_addr_t dest; /**< destination address */
union {
snd_seq_ev_note_t note;
snd_seq_ev_ctrl_t control;
snd_seq_ev_raw8_t raw8;
snd_seq_ev_raw32_t raw32;
snd_seq_ev_ext_t ext;
snd_seq_ev_ipcshm_t ipcshm;
snd_seq_ev_queue_control_t queue;
snd_seq_timestamp_t time;
snd_seq_addr_t addr;
snd_seq_connect_t connect;
snd_seq_result_t result;
snd_seq_ev_instr_begin_t instr_begin;
snd_seq_ev_sample_control_t sample;
snd_seq_ev_note_t note; /**< note information */
snd_seq_ev_ctrl_t control; /**< MIDI control information */
snd_seq_ev_raw8_t raw8; /**< raw8 data */
snd_seq_ev_raw32_t raw32; /**< raw32 data */
snd_seq_ev_ext_t ext; /**< external data */
snd_seq_ev_ipcshm_t ipcshm; /**< IPC shared memory */
snd_seq_ev_queue_control_t queue; /**< queue control */
snd_seq_timestamp_t time; /**< timestamp */
snd_seq_addr_t addr; /**< address */
snd_seq_connect_t connect; /**< connect information */
snd_seq_result_t result; /**< operation result code */
snd_seq_ev_instr_begin_t instr_begin; /**< instrument */
snd_seq_ev_sample_control_t sample; /**< sample control */
} data; /**< event data... */
} snd_seq_event_t;

6
src/instr/fm.c
View file

@ -115,9 +115,15 @@ int snd_instr_fm_convert_to_stream(snd_instr_fm_t *fm,
* \param simple Result - allocated FM instrument handle
* \return 0 on success otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_instr_fm_convert_from_stream(snd_instr_header_t *__data ATTRIBUTE_UNUSED,
size_t size ATTRIBUTE_UNUSED,
snd_instr_fm_t **simple ATTRIBUTE_UNUSED)
#else
int snd_instr_fm_convert_from_stream(snd_instr_header_t *__data,
size_t size,
snd_instr_fm_t **simple)
#endif
{
/* TODO */
return -ENXIO;

10
src/instr/iwffff.c
View file

@ -343,7 +343,11 @@ int snd_instr_iwffff_open_rom(snd_iwffff_handle_t **handle, int card, int bank,
* \param file ROM file number
* \return 0 on success otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_instr_iwffff_open_rom_file(snd_iwffff_handle_t **handle ATTRIBUTE_UNUSED, const char *name ATTRIBUTE_UNUSED, int bank ATTRIBUTE_UNUSED, int file ATTRIBUTE_UNUSED)
#else
int snd_instr_iwffff_open_rom_file(snd_iwffff_handle_t **handle, const char *name, int bank, int file)
#endif
{
/* TODO */
return -ENXIO;
@ -899,9 +903,15 @@ int snd_instr_iwffff_convert_to_stream(snd_instr_iwffff_t *iwffff,
* \param iwffff Result - allocated IWFFFF instrument handle
* \return 0 on success otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_instr_iwffff_convert_from_stream(snd_instr_header_t *data ATTRIBUTE_UNUSED,
size_t size ATTRIBUTE_UNUSED,
snd_instr_iwffff_t **iwffff ATTRIBUTE_UNUSED)
#else
int snd_instr_iwffff_convert_from_stream(snd_instr_header_t *data,
size_t size,
snd_instr_iwffff_t **iwffff)
#endif
{
/* TODO */
return -ENXIO;

6
src/instr/simple.c
View file

@ -123,9 +123,15 @@ int snd_instr_simple_convert_to_stream(snd_instr_simple_t *simple,
* \param simple Result - simple instrument handle
* \return 0 on success otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_instr_simple_convert_from_stream(snd_instr_header_t *__data ATTRIBUTE_UNUSED,
size_t size ATTRIBUTE_UNUSED,
snd_instr_simple_t **simple ATTRIBUTE_UNUSED)
#else
int snd_instr_simple_convert_from_stream(snd_instr_header_t *__data,
size_t size,
snd_instr_simple_t **simple)
#endif
{
/* TODO */
return -ENXIO;

36
src/pcm/pcm.c
View file

@ -4448,7 +4448,11 @@ link_warning(snd_pcm_sw_params_get_start_mode, "Warning: start_mode is deprecate
* \param val Xrun mode
* \return 0 otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_xrun_mode(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_xrun_t val)
#else
int snd_pcm_sw_params_set_xrun_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_xrun_t val)
#endif
{
assert(pcm && params);
switch (val) {
@ -4492,7 +4496,11 @@ link_warning(snd_pcm_sw_params_get_xrun_mode, "Warning: xrun_mode is deprecated,
* \param val Timestamp mode
* \return 0 otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_tstamp_mode(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val)
#else
int snd_pcm_sw_params_set_tstamp_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val)
#endif
{
assert(pcm && params);
assert(val <= SND_PCM_TSTAMP_LAST);
@ -4535,7 +4543,11 @@ unsigned int snd_pcm_sw_params_get_period_step(const snd_pcm_sw_params_t *params
* \param val Minimum ticks to sleep or 0 to disable the use of tick timer
* \return 0 otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, unsigned int val)
#else
int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val)
#endif
{
assert(pcm && params);
params->sleep_min = val;
@ -4560,7 +4572,11 @@ unsigned int snd_pcm_sw_params_get_sleep_min(const snd_pcm_sw_params_t *params)
* \param val Minimum avail frames to consider PCM ready
* \return 0 otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#else
int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#endif
{
assert(pcm && params);
params->avail_min = val;
@ -4586,7 +4602,11 @@ snd_pcm_uframes_t snd_pcm_sw_params_get_avail_min(const snd_pcm_sw_params_t *par
* \param val Chunk size (frames are attempted to be transferred in chunks)
* \return 0 otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_xfer_align(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#else
int snd_pcm_sw_params_set_xfer_align(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#endif
{
assert(pcm && params);
assert(val % pcm->min_align == 0);
@ -4616,7 +4636,11 @@ snd_pcm_uframes_t snd_pcm_sw_params_get_xfer_align(const snd_pcm_sw_params_t *pa
* PCM is automatically started when playback frames available to PCM
* are >= threshold or when requested capture frames are >= threshold
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#else
int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#endif
{
assert(pcm && params);
params->start_threshold = val;
@ -4647,7 +4671,11 @@ snd_pcm_uframes_t snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_
* PCM is automatically stopped in #SND_PCM_STATE_XRUN state when available
* frames is >= threshold
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#else
int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#endif
{
assert(pcm && params);
params->stop_threshold = val;
@ -4679,7 +4707,11 @@ snd_pcm_uframes_t snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t
* #snd_pcm_sw_params_set_silence_size) when playback underrun is nearer
* than silence threshold
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#else
int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#endif
{
assert(pcm && params);
assert(val + params->silence_size <= pcm->buffer_size);
@ -4714,7 +4746,11 @@ snd_pcm_uframes_t snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_param
* underrun is nearer than silence threshold (see
* #snd_pcm_sw_params_set_silence_threshold)
*/
#ifndef DOXYGEN
int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#else
int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
#endif
{
assert(pcm && params);
assert(val + params->silence_threshold <= pcm->buffer_size);

12
src/rawmidi/rawmidi.c
View file

@ -620,7 +620,11 @@ void snd_rawmidi_params_copy(snd_rawmidi_params_t *dst, const snd_rawmidi_params
* \param val size in bytes
* \return 0 on success otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_rawmidi_params_set_buffer_size(snd_rawmidi_t *rawmidi ATTRIBUTE_UNUSED, snd_rawmidi_params_t *params, size_t val)
#else
int snd_rawmidi_params_set_buffer_size(snd_rawmidi_t *rawmidi, snd_rawmidi_params_t *params, size_t val)
#endif
{
assert(rawmidi && params);
assert(val > params->avail_min);
@ -645,7 +649,11 @@ size_t snd_rawmidi_params_get_buffer_size(const snd_rawmidi_params_t *params)
* \param params pointer to a snd_rawmidi_params_t structure
* \param val desired value
*/
#ifndef DOXYGEN
int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rawmidi ATTRIBUTE_UNUSED, snd_rawmidi_params_t *params, size_t val)
#else
int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rawmidi, snd_rawmidi_params_t *params, size_t val)
#endif
{
assert(rawmidi && params);
assert(val < params->buffer_size);
@ -671,7 +679,11 @@ size_t snd_rawmidi_params_get_avail_min(const snd_rawmidi_params_t *params)
* \param val value: 0 = enable to send the active sensing message, 1 = disable
* \return 0 on success otherwise a negative error code
*/
#ifndef DOXYGEN
int snd_rawmidi_params_set_no_active_sensing(snd_rawmidi_t *rawmidi ATTRIBUTE_UNUSED, snd_rawmidi_params_t *params, int val)
#else
int snd_rawmidi_params_set_no_active_sensing(snd_rawmidi_t *rawmidi, snd_rawmidi_params_t *params, int val)
#endif
{
assert(rawmidi && params);
params->no_active_sensing = val;

4
src/seq/seq.c
View file

@ -2530,7 +2530,11 @@ snd_seq_event_t *snd_seq_create_event(void)
*
* this is obsolete. only for compatibility
*/
#ifndef DOXYGEN
int snd_seq_free_event(snd_seq_event_t *ev ATTRIBUTE_UNUSED)
#else
int snd_seq_free_event(snd_seq_event_t *ev)
#endif
{
return 0;
}