]> git.alsa-project.org Git - alsa-lib.git/commitdiff
doxygen: fix broken examples links
authorborine <32966433+borine@users.noreply.github.com>
Wed, 2 Aug 2023 15:11:50 +0000 (16:11 +0100)
committerJaroslav Kysela <perex@perex.cz>
Fri, 1 Sep 2023 14:12:32 +0000 (16:12 +0200)
From: borine@github
Link: https://github.com/alsa-project/alsa-lib/pull/340
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
src/pcm/pcm.c
src/rawmidi/rawmidi.c
src/timer/timer.c

index 2077d6fac3896c7eab739ad9618df86b46bce8a1..ad9e8956a3298cf7a29336eead02d5980196a0ca 100644 (file)
@@ -223,7 +223,7 @@ There are two methods to transfer samples in application. The first method
 is the standard read / write one. The second method, uses the direct audio
 buffer to communicate with the device while ALSA library manages this space
 itself. You can find examples of all communication schemes for playback
-in \ref example_test_pcm "Sine-wave generator example". To complete the
+in \link example_test_pcm Sine-wave generator example \endlink. To complete the
 list, we should note that #snd_pcm_wait() function contains
 embedded poll waiting implementation.
 
@@ -632,30 +632,39 @@ The null device is null plugin. This device has not any arguments.
 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
 \par
-alsa-lib/test/pcm.c example shows various transfer methods for the playback direction.
+\link example_test_pcm alsa-lib/test/pcm.c \endlink
+example shows various transfer methods for the playback direction.
 
 \par Minimalistic PCM playback code
 \par
-alsa-lib/test/pcm_min.c example shows the minimal code to produce a sound.
+\link example_test_minimal alsa-lib/test/pcm_min.c \endlink
+example shows the minimal code to produce a sound.
 
 \par Latency measuring tool
 \par
-alsa-lib/test/latency.c example shows the measuring of minimal latency between capture and
+\link example_test_latency alsa-lib/test/latency.c \endlink
+example shows the measuring of minimal latency between capture and
 playback devices.
 
 */
 
 /**
 \example ../../test/pcm.c
+\anchor example_test_pcm
+Shows various transfer methods for the playback direction.
 */
 /**
 \example ../../test/pcm_min.c
+\anchor example_test_minimal
+Shows the minimal code to produce a sound.
 */
 /**
 \example ../../test/latency.c
+\anchor example_test_latency
+Shows the measuring of minimal latency between capture and
+playback devices.
 */
 
 #include "pcm_local.h"
@@ -7431,7 +7440,7 @@ int __snd_pcm_mmap_begin(snd_pcm_t *pcm, const snd_pcm_channel_area_t **areas,
  _skip:
 \endcode
  *
- * Look to the \ref example_test_pcm "Sine-wave generator" example
+ * Look to the \link example_test_pcm Sine-wave generator \endlink example
  * for more details about the generate_sine function.
  *
  * The function is thread-safe when built with the proper option.
index 8dca9312c6d97fcced2e48f5e6e192ea5ebfd847..316f524b85ad5a9d3b6ef5fc3257aa024c20d72a 100644 (file)
@@ -132,7 +132,7 @@ The timestamping is available only on input streams.
 The full featured examples with cross-links:
 
 \par Simple input/output test program
-\ref example_test_rawmidi "example code"
+\link example_test_rawmidi example code \endlink
 \par
 This example shows open and read/write rawmidi operations.
 
@@ -141,6 +141,7 @@ This example shows open and read/write rawmidi operations.
 /**
  * \example ../test/rawmidi.c
  * \anchor example_test_rawmidi
+ * Shows open and read/write rawmidi operations.
  */
  
 #include <stdio.h>
index 6fc710b9f0788e1ecd871fbf82e8252d72161cb1..0f8491b86738d3a6b7ab130b3a3a7530b6f8a0f3 100644 (file)
@@ -56,7 +56,7 @@ Events are read via snd_timer_read() function.
 The full featured examples with cross-links:
 
 \par Simple timer test program
-\ref example_test_timer "example code"
+\link example_test_timer example code \endlink
 \par
 This example shows opening a timer device and reading of timer events.