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

fix doxygen errors (syntax errors and wrong references)

Browse source
This commit is contained in:
Clemens Ladisch 2004-03-02 17:13:49 +00:00
parent 59b6cbec84
commit 16a15f56c4
4 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/doxygen.cfg
View file

@ -94,7 +94,13 @@ SHOW_INCLUDE_FILES = NO
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = NO
INHERIT_DOCS = YES INHERIT_DOCS = YES
ENABLED_SECTIONS = "" ENABLED_SECTIONS = ""
PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" "ATTRIBUTE_UNUSED=" ALSA_PCM_NEW_HW_PARAMS_API MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" \
"ATTRIBUTE_UNUSED=" \
ALSA_PCM_NEW_HW_PARAMS_API \
"use_default_symbol_version(x,y,z)=" \
"link_warning(x,y)="
OPTIMIZE_OUTPUT_FOR_C = YES # doxygen 1.2.6 option OPTIMIZE_OUTPUT_FOR_C = YES # doxygen 1.2.6 option

6
src/pcm/pcm.c
View file

@ -314,7 +314,7 @@ is equal or greater than this value, then application will be activated.
The timestamp mode specifies, if timestamps are activated. Currently, only The timestamp mode specifies, if timestamps are activated. Currently, only
#SND_PCM_TSTAMP_NONE and #SND_PCM_TSTAMP_MMAP #SND_PCM_TSTAMP_NONE and #SND_PCM_TSTAMP_MMAP
\endlink modes are known. The mmap mode means that timestamp is taken modes are known. The mmap mode means that timestamp is taken
on every period time boundary. on every period time boundary.
\par Minimal sleep \par Minimal sleep
@ -408,7 +408,7 @@ These functions directly and indirectly affecting the stream state:
The #snd_pcm_hw_params() function brings the stream state The #snd_pcm_hw_params() function brings the stream state
to #SND_PCM_STATE_SETUP to #SND_PCM_STATE_SETUP
if successfully finishes, otherwise the state #SND_PCM_STATE_OPEN if successfully finishes, otherwise the state #SND_PCM_STATE_OPEN
\endlink is entered. is entered.
When it is brought to SETUP state, this function automatically When it is brought to SETUP state, this function automatically
calls #snd_pcm_prepar() function to bring to the PREPARE state calls #snd_pcm_prepar() function to bring to the PREPARE state
as below. as below.
@ -1221,7 +1221,7 @@ int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm)
* \link ::snd_pcm_poll_descriptors_count() \endlink function. * \link ::snd_pcm_poll_descriptors_count() \endlink function.
* *
* For reading the returned events of poll descriptor after poll() system * For reading the returned events of poll descriptor after poll() system
* call, use \link ::snd_pcm_poll_descriptors_revent() \endlink function. * call, use \link ::snd_pcm_poll_descriptors_revents() \endlink function.
* The field values in pollfd structs may be bogus. * The field values in pollfd structs may be bogus.
*/ */
int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space) int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space)

2
src/pcm/pcm_dsnoop.c
View file

@ -663,7 +663,7 @@ int snd_pcm_dsnoop_open(snd_pcm_t **pcmp, const char *name,
/*! \page pcm_plugins /*! \page pcm_plugins
\section pcm_plugins_snoop Plugin: dsnoop \section pcm_plugins_dsnoop Plugin: dsnoop
This plugin splits one capture stream to more. This plugin splits one capture stream to more.
It works the reverse way of \ref pcm_plugins_dmix "dmix plugin", It works the reverse way of \ref pcm_plugins_dmix "dmix plugin",

2
src/seq/seq.c
View file

@ -77,7 +77,7 @@ clients. A port is corresponding to the MIDI port in the case of MIDI device,
but in general it is nothing but the access point between other clients. but in general it is nothing but the access point between other clients.
Each port may have capability flags, which specify the read/write Each port may have capability flags, which specify the read/write
accessbility and subscription permissions of the port. accessbility and subscription permissions of the port.
For creation of a port, call #snd_seq_create_port() \endlink For creation of a port, call #snd_seq_create_port()
with the appropirate port attribute specified in #snd_seq_port_info_t with the appropirate port attribute specified in #snd_seq_port_info_t
reocrd. reocrd.