fix doc errors

Fix various errors in the documentation that make doxygen complain.

Signed-off-by: Clemens Ladisch <clemens@ladisch.de>

diff --git a/include/conf.h b/include/conf.h
index 0c554a705b8493ad66db97511349cc18fc696a12..ff270f61738333127cd04ef535a550710fb16020 100644 (file)
--- a/include/conf.h
+++ b/include/conf.h
@@ -58,7 +58,7 @@ typedef enum _snd_config_type {
         SND_CONFIG_TYPE_POINTER,
        /** Compound node. */
        SND_CONFIG_TYPE_COMPOUND = 1024
-} snd_config_type_t; /**< \brief Configuration node type. */
+} snd_config_type_t;
 
 /**
  * \brief Internal structure for a configuration node object.

diff --git a/include/pcm_ioplug.h b/include/pcm_ioplug.h
index b5968f1a6bd9402802d895874f2b8370d15668db..6331cf071f83feb0a16b7d9c47a84b24d0a98e1c 100644 (file)
--- a/include/pcm_ioplug.h
+++ b/include/pcm_ioplug.h
@@ -55,11 +55,11 @@ typedef struct snd_pcm_ioplug snd_pcm_ioplug_t;
 /** Callback table of ioplug */
 typedef struct snd_pcm_ioplug_callback snd_pcm_ioplug_callback_t;
 
-/**
+/*
  * bit flags for additional conditions
  */
-#define SND_PCM_IOPLUG_FLAG_LISTED     (1<<0)          /* list up this PCM */
-#define SND_PCM_IOPLUG_FLAG_MONOTONIC  (1<<1)          /* monotonic timestamps */
+#define SND_PCM_IOPLUG_FLAG_LISTED     (1<<0)          /**< list up this PCM */
+#define SND_PCM_IOPLUG_FLAG_MONOTONIC  (1<<1)          /**< monotonic timestamps */
 
 /*
  * Protocol version

diff --git a/src/control/control.c b/src/control/control.c
index c09079736c5ed1e41a1f98036f91deff7aeb1832..c9b04a1bdb48c76427da349953eb5cf8fd9b465d 100644 (file)
--- a/src/control/control.c
+++ b/src/control/control.c
@@ -211,7 +211,7 @@ int snd_ctl_poll_descriptors_revents(snd_ctl_t *ctl, struct pollfd *pfds, unsign
 }
 
 /**
- * \brief Ask to be informed about events (poll, #snd_ctl_async, #snd_ctl_read)
+ * \brief Ask to be informed about events (poll, #snd_async_add_ctl_handler, #snd_ctl_read)
  * \param ctl CTL handle
  * \param subscribe 0 = unsubscribe, 1 = subscribe
  * \return 0 on success otherwise a negative error code

diff --git a/src/control/control_ext.c b/src/control/control_ext.c
index d1fe8eaadec55671d9fcdfcc456d9d13e97a0d84..e20d4f3b49da8afb074192ec011c3b8fa51d6f44 100644 (file)
--- a/src/control/control_ext.c
+++ b/src/control/control_ext.c
@@ -586,7 +586,7 @@ total number of control elements.  The elem_list returns the control element ID
 of the corresponding element offset (the offset is from 0 to elem_count - 1).
 The id field is initialized to all zero in prior to elem_list callback.  The callback
 has to fill the necessary field (typically iface, name and index) in return via the
-standard control API functions like #snd_ctl_elem_id_set_ifarce,
+standard control API functions like #snd_ctl_elem_id_set_interface,
 #snd_ctl_elem_id_set_name and #snd_ctl_elem_id_set_index, etc.  The callbacks should
 return 0 if successful, or a negative error code.
 

diff --git a/src/control/tlv.c b/src/control/tlv.c
index 7627f57957136a12343e917879b3dbdd3f53fa56..cfd9b9735749db2e3f5153d84fd06ea749804b54 100644 (file)
--- a/src/control/tlv.c
+++ b/src/control/tlv.c
@@ -405,7 +405,6 @@ static int get_tlv_info(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
  * \brief Get the dB min/max values on the given control element
  * \param ctl the control handler
  * \param id the element id
- * \param volume the raw volume value to convert
  * \param min the pointer to store the minimum dB value (in 0.01dB unit)
  * \param max the pointer to store the maximum dB value (in 0.01dB unit)
  * \return 0 if successful, or a negative error code

diff --git a/src/output.c b/src/output.c
index 8a723f8b4c524e34ad0eef0d6777fae7a6779e38..adc461aeccbe4d6891f5711089b8390c99b8079b 100644 (file)
--- a/src/output.c
+++ b/src/output.c
@@ -333,7 +333,7 @@ static const snd_output_ops_t snd_output_buffer_ops = {
 #endif
 
 /**
- * \brief Returns the address of the buffer of a #SND_OUTPUT_TYPE_BUFFER output handle.
+ * \brief Returns the address of the buffer of a #SND_OUTPUT_BUFFER output handle.
  * \param output The output handle.
  * \param buf The functions puts the current address of the buffer at the
  *            address specified by \p buf.

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index e63bbe9e5dbf44aadda4341c5e68625e594dccf7..29d4492dfb4becdaf8ca0d97f1f94d783bcfcc5e 100644 (file)
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -2460,8 +2460,8 @@ snd_pcm_sframes_t snd_pcm_avail(snd_pcm_t *pcm)
 /**
  * \brief Combine snd_pcm_avail and snd_pcm_delay functions
  * \param pcm PCM handle
- * \param avail Number of available frames in the ring buffer
- * \param delay Total I/O latency in frames
+ * \param availp Number of available frames in the ring buffer
+ * \param delayp Total I/O latency in frames
  * \return zero on success otherwise a negative error code
  *
  * The avail and delay values retuned are in sync.

diff --git a/src/pcm/pcm_dmix.c b/src/pcm/pcm_dmix.c
index 5b967e864b675c8ef712e6ff4f87be494fb16473..90470e0a2a316990bd4fd82669660869568dd9fb 100644 (file)
--- a/src/pcm/pcm_dmix.c
+++ b/src/pcm/pcm_dmix.c
@@ -145,9 +145,11 @@ static void dmix_server_free(snd_pcm_direct_t *dmix)
 #elif defined(__x86_64__)
 #include "pcm_dmix_x86_64.c"
 #else
+#ifndef DOC_HIDDEN
 #define mix_select_callbacks(x)        generic_mix_select_callbacks(x)
 #define dmix_supported_format generic_dmix_supported_format
 #endif
+#endif
 
 static void mix_areas(snd_pcm_direct_t *dmix,
                      const snd_pcm_channel_area_t *src_areas,

diff --git a/src/pcm/pcm_ioplug.c b/src/pcm/pcm_ioplug.c
index e43d3548ba4106816b62d88f10ebb3e394a82e72..c582f5afade7eb2fe40ba9e470567af9b01f5934 100644 (file)
--- a/src/pcm/pcm_ioplug.c
+++ b/src/pcm/pcm_ioplug.c
@@ -877,7 +877,7 @@ callback.
 Finally, the dump callback is used to print the status of the plugin.
 
 The hw_params constraints can be defined via either
-#snd_pcm_iplug_set_param_minmax() and #snd_pcm_ioplug_set_param_list()
+#snd_pcm_ioplug_set_param_minmax() and #snd_pcm_ioplug_set_param_list()
 functions after calling #snd_pcm_ioplug_create().
 The former defines the minimal and maximal acceptable values for the
 given hw_params parameter (SND_PCM_IOPLUG_HW_XXX).

diff --git a/src/pcm/pcm_mmap_emul.c b/src/pcm/pcm_mmap_emul.c
index 0dc19736bb9cc4806a523474778537dd878464fc..e356e0bff910f92a234844ac9a7756d0b43b4893 100644 (file)
--- a/src/pcm/pcm_mmap_emul.c
+++ b/src/pcm/pcm_mmap_emul.c
@@ -34,6 +34,7 @@
 const char *_snd_module_pcm_mmap_emul = "";
 #endif
 
+#ifndef DOC_HIDDEN
 /*
  *
  */
@@ -44,6 +45,7 @@ typedef struct {
        snd_pcm_uframes_t hw_ptr;
        snd_pcm_uframes_t appl_ptr;
 } mmap_emul_t;
+#endif
 
 /*
  * here goes a really tricky part; hw_refine falls back to ACCESS_RW_* type

diff --git a/src/pcm/pcm_rate.c b/src/pcm/pcm_rate.c
index c28884bc08564be8af1cfb090747a263631a0e9c..c705875c73ff1a04080505b889b99e5bfd3ed756 100644 (file)
--- a/src/pcm/pcm_rate.c
+++ b/src/pcm/pcm_rate.c
@@ -1326,7 +1326,7 @@ static int rate_open_func(snd_pcm_rate_t *rate, const char *type)
  * \param name Name of PCM
  * \param sformat Slave format
  * \param srate Slave rate
- * \param type SRC type string
+ * \param converter SRC type string node
  * \param slave Slave PCM handle
  * \param close_slave When set, the slave PCM handle is closed with copy PCM
  * \retval zero on success otherwise a negative error code

diff --git a/src/rawmidi/rawmidi.c b/src/rawmidi/rawmidi.c
index 226e65c5dda1c0789bd289df7c2fb52008dbb0bb..b28488a81fb8216bb2a1657f7ae077dd32e2453f 100644 (file)
--- a/src/rawmidi/rawmidi.c
+++ b/src/rawmidi/rawmidi.c
@@ -987,6 +987,7 @@ ssize_t snd_rawmidi_read(snd_rawmidi_t *rawmidi, void *buffer, size_t size)
        return (rawmidi->ops->read)(rawmidi, buffer, size);
 }
 
+#ifndef DOC_HIDDEN
 int snd_rawmidi_conf_generic_id(const char *id)
 {
        static const char ids[][8] = {
@@ -1002,3 +1003,4 @@ int snd_rawmidi_conf_generic_id(const char *id)
        }
        return 0;
 }
+#endif

diff --git a/src/seq/seq.c b/src/seq/seq.c
index 7b777a1c04d9f6cbc4a0418a989deda4fd8cb343..f5dfe9ca56bbe25533945ffe933c642e1bd32311 100644 (file)
--- a/src/seq/seq.c
+++ b/src/seq/seq.c
@@ -463,7 +463,7 @@ void set_tempo(snd_seq_t *handle)
 \endcode
 
 For changing the (running) queue's tempo on the fly, you can either
-set the tempo via #snd_seq_queue_tempo() or send a MIDI tempo event
+set the tempo via #snd_seq_set_queue_tempo() or send a MIDI tempo event
 to the system timer port.  For example,
 \code
 int change_tempo(snd_seq_t *handle, int q, unsigned int tempo)
@@ -540,7 +540,7 @@ to the specified port.
 For example, when a port makes READ subscription
 to MIDI input port, this port must have #SND_SEQ_PORT_CAP_WRITE capability,
 but no #SND_SEQ_PORT_CAP_SUBS_WRITE capability is required.
-Only MIDI input port must have #SND_SEQ_PORT_SUBS_READ capability.
+Only MIDI input port must have #SND_SEQ_PORT_CAP_SUBS_READ capability.
 
 As default, the connection of ports via the third client is always allowed
 if proper read and write (subscription) capabilities are set both to the
@@ -579,7 +579,7 @@ snd_seq_subscribe_port(handle, subs);
 
 When the connection should be exclusively done only between
 a certain pair, set <i>exclusive</i> attribute to the subscription
-record before calling #snd_seq_port_subscribe.
+record before calling #snd_seq_subscribe_port.
 \code
 snd_seq_port_subscribe_set_exclusive(subs, 1);
 \endcode
@@ -663,7 +663,7 @@ Assume connection from application 128:0 to 129:0,
 and that subscription is done by the third application (130:0).
 The sender must have capabilities both
 #SND_SEQ_PORT_CAP_READ and
-#SND_SEQ_PORT_SUBS_READ,
+#SND_SEQ_PORT_CAP_SUBS_READ,
 and the receiver
 #SND_SEQ_PORT_CAP_WRITE and
 #SND_SEQ_PORT_CAP_SUBS_WRITE, respectively.
@@ -1471,7 +1471,7 @@ int snd_seq_client_info_get_client(const snd_seq_client_info_t *info)
  * \param info client_info container
  * \return client type
  *
- * The client type is either #SEQ_CLIENT_TYPE_KERNEL or #SEQ_CLIENT_TYPE_USER
+ * The client type is either #SND_SEQ_KERNEL_CLIENT or #SND_SEQ_USER_CLIENT
  * for kernel or user client respectively.
  *
  * \sa snd_seq_get_client_info()