From: Clemens Ladisch <clemens@ladisch.de>
Date: Tue, 2 Mar 2004 17:13:49 +0000 (+0000)
Subject: fix doxygen errors (syntax errors and wrong references)
X-Git-Tag: v1.0.4~34
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=16a15f56c4b7d5b342945dbc0a0c8dd1f44097a5;p=alsa-lib.git

fix doxygen errors (syntax errors and wrong references)
---

diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
index b67609c4..ef1a0575 100644
--- a/doc/doxygen.cfg
+++ b/doc/doxygen.cfg
@@ -94,7 +94,13 @@ SHOW_INCLUDE_FILES = NO
 JAVADOC_AUTOBRIEF = NO
 INHERIT_DOCS	 = YES
 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
 
diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index d455cbda..deb0a605 100644
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -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
 #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.
 
 \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
 to #SND_PCM_STATE_SETUP
 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
 calls #snd_pcm_prepar() function to bring to the PREPARE state
 as below.
@@ -1221,7 +1221,7 @@ int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm)
  * \link ::snd_pcm_poll_descriptors_count() \endlink function.
  *
  * 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.
  */
 int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space)
diff --git a/src/pcm/pcm_dsnoop.c b/src/pcm/pcm_dsnoop.c
index 63d3169e..2ac62dc8 100644
--- a/src/pcm/pcm_dsnoop.c
+++ b/src/pcm/pcm_dsnoop.c
@@ -663,7 +663,7 @@ int snd_pcm_dsnoop_open(snd_pcm_t **pcmp, const char *name,
 
 /*! \page pcm_plugins
 
-\section pcm_plugins_snoop Plugin: dsnoop
+\section pcm_plugins_dsnoop Plugin: dsnoop
 
 This plugin splits one capture stream to more.
 It works the reverse way of \ref pcm_plugins_dmix "dmix plugin",
diff --git a/src/seq/seq.c b/src/seq/seq.c
index 22ea81f1..c4754b5e 100644
--- a/src/seq/seq.c
+++ b/src/seq/seq.c
@@ -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.
 Each port may have capability flags, which specify the read/write
 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
 reocrd.