Fix examples for PCM API. Fix dogygen warnings.

diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
index 5458f24157840cf2b2c1bd8208f22f23498d44cf..2ed205d3d0e7dd0f92ea330f7723c3f228a6efae 100644 (file)
--- a/doc/doxygen.cfg
+++ b/doc/doxygen.cfg
@@ -94,8 +94,7 @@ EXCLUDE                = ../src/control/control_local.h \
                   ../src/seq/seq_local.h
 RECURSIVE       = YES
 FILE_PATTERNS    = *.c *.h
-EXAMPLE_PATH     = ../test/pcm.c ../test/latency.c ../test/rawmidi.c \
-                  ../test/timer.c
+EXAMPLE_PATH     = ../test
 IMAGE_PATH      = pictures
 QUIET            = YES
 

diff --git a/src/control/hcontrol.c b/src/control/hcontrol.c
index 5a234a225f320ac186093d7882b619034cc546f5..9738d6520be036ac6d3485e8b3d3a2941c3e66fd 100644 (file)
--- a/src/control/hcontrol.c
+++ b/src/control/hcontrol.c
@@ -822,7 +822,7 @@ int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value)
  * \param elem HCTL element
  * \param value HCTL element value
  * \retval 0 on success
- * \ratval >1 on success when value was changed
+ * \retval >1 on success when value was changed
  * \retval <0 a negative error code on failure
  */
 int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value)
@@ -854,7 +854,7 @@ int snd_hctl_elem_tlv_read(snd_hctl_elem_t *elem, unsigned int *tlv, unsigned in
  * \param elem HCTL element
  * \param tlv TLV array for value
  * \retval 0 on success
- * \ratval >1 on success when value was changed
+ * \retval >1 on success when value was changed
  * \retval <0 a negative error code on failure
  */
 int snd_hctl_elem_tlv_write(snd_hctl_elem_t *elem, const unsigned int *tlv)
@@ -870,7 +870,7 @@ int snd_hctl_elem_tlv_write(snd_hctl_elem_t *elem, const unsigned int *tlv)
  * \param elem HCTL element
  * \param tlv TLV array for value
  * \retval 0 on success
- * \ratval >1 on success when value was changed
+ * \retval >1 on success when value was changed
  * \retval <0 a negative error code on failure
  */
 int snd_hctl_elem_tlv_command(snd_hctl_elem_t *elem, const unsigned int *tlv)

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index a375291eff8eb811d18c724dc576ed0baf881cb9..15125923007356d2e12582cd0808e0bfbcd6af9a 100644 (file)
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -600,39 +600,34 @@ The null device is null plugin. This device has not any arguments.
 
 \section pcm_examples Examples
 
-The full featured examples with cross-links:
+The full featured examples with cross-links can be found in Examples section
+(see top of page):
 
+\anchor example_test_pcm
 \par Sine-wave generator
-\ref example_test_pcm "example code"
 \par
-This example shows various transfer methods for the playback direction.
+alsa-lib/test/pcm.c example shows various transfer methods for the playback direction.
 
 \par Minimalistic PCM playback code
-\ref example_test_pcm_min "example code"
 \par
-This example shows the minimal code to produce a sound.
+alsa-lib/test/pcm_min.c example shows the minimal code to produce a sound.
 
 \par Latency measuring tool
-\ref example_test_latency "example code"
 \par
-This example shows the measuring of minimal latency between capture and
+alsa-lib/test/latency.c example shows the measuring of minimal latency between capture and
 playback devices.
 
 */
 
 /**
- * \example ../test/pcm.c
- * \anchor example_test_pcm
- */
+\example ../../test/pcm.c
+*/
 /**
- * \example ../test/pcm_min.c
- * \anchor example_test_pcm_min
- */
+\example ../../test/pcm_min.c
+*/
 /**
- * \example ../test/latency.c
- * \anchor example_test_latency
- */
-
+\example ../../test/latency.c
+*/
 
 #include <stdio.h>
 #include <string.h>

diff --git a/src/pcm/pcm_rate.c b/src/pcm/pcm_rate.c
index bbf0df61e878a7badfcf0f9f698b789de8bdaa9b..90c21f1339daad53cb76eabf69f27bd9d781dd69 100644 (file)
--- a/src/pcm/pcm_rate.c
+++ b/src/pcm/pcm_rate.c
@@ -419,9 +419,11 @@ static void convert_to_s16(snd_pcm_rate_t *rate, int16_t *buf,
                           snd_pcm_uframes_t offset, unsigned int frames,
                           unsigned int channels)
 {
+#ifndef DOC_HIDDEN
 #define GET16_LABELS
 #include "plugin_ops.h"
 #undef GET16_LABELS
+#endif /* DOC_HIDDEN */
        void *get = get16_labels[rate->get_idx];
        const char *src;
        int16_t sample;
@@ -438,9 +440,11 @@ static void convert_to_s16(snd_pcm_rate_t *rate, int16_t *buf,
                for (c = 0; c < channels; c++) {
                        src = srcs[c];
                        goto *get;
+#ifndef DOC_HIDDEN
 #define GET16_END after_get
 #include "plugin_ops.h"
 #undef GET16_END
+#endif /* DOC_HIDDEN */
                after_get:
                        *buf++ = sample;
                        srcs[c] += src_step[c];
@@ -453,9 +457,11 @@ static void convert_from_s16(snd_pcm_rate_t *rate, const int16_t *buf,
                             snd_pcm_uframes_t offset, unsigned int frames,
                             unsigned int channels)
 {
+#ifndef DOC_HIDDEN
 #define PUT16_LABELS
 #include "plugin_ops.h"
 #undef PUT16_LABELS
+#endif /* DOC_HIDDEN */
        void *put = put16_labels[rate->put_idx];
        char *dst;
        int16_t sample;
@@ -473,9 +479,11 @@ static void convert_from_s16(snd_pcm_rate_t *rate, const int16_t *buf,
                        dst = dsts[c];
                        sample = *buf++;
                        goto *put;
+#ifndef DOC_HIDDEN
 #define PUT16_END after_put
 #include "plugin_ops.h"
 #undef PUT16_END
+#endif /* DOC_HIDDEN */
                after_put:
                        dsts[c] += dst_step[c];
                }