doc: link examples to Doxygen docs

Include examples to the documentation, using Doxygen's example system.
This commit is contained in:
Pauli Virtanen 2021-10-09 23:25:29 +03:00
parent f6d69f9bcd
commit 98a0e54d5f
25 changed files with 192 additions and 4 deletions

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Audio filter using \ref pw_filter "pw_filter".
[title]
*/
#include <stdio.h>
#include <errno.h>
#include <math.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Audio source using \ref pw_filter "pw_filter"
[title]
*/
#include <stdio.h>
#include <errno.h>
#include <math.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Audio source using \ref pw_stream "pw_stream".
[title]
*/
#include <stdio.h>
#include <errno.h>
#include <math.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Using the \ref spa_device "SPA Device API", among other things.
[title]
*/
#include <string.h>
#include <stdio.h>
#include <errno.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Exporting and implementing a video sink SPA node, using \ref api_pw_core.
[title]
*/
#include <errno.h>
#include <stdio.h>
#include <sys/mman.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Exporting and implementing a video source SPA node, using \ref api_pw_core.
[title]
*/
#include <errno.h>
#include <stdio.h>
#include <math.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Exporting and loading a SPA device, using \ref api_pw_core.
[title]
*/
#include <stdio.h>
#include <sys/mman.h>
#include <signal.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Exporting and loading a SPA node, using \ref api_pw_core.
[title]
*/
#include <stdio.h>
#include <sys/mman.h>
#include <signal.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Using libspa-v4l2
[title]
*/
#include <stdio.h>
#include <sys/mman.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
SDL2 video format conversions
[title]
*/
#include <SDL2/SDL.h>
#include <spa/utils/type.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Video input stream using \ref pw_filter "pw_filter".
[title]
*/
#include <stdio.h>
#include <unistd.h>
#include <sys/mman.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Video input stream using \ref pw_stream_trigger_process, for pull mode.
[title]
*/
#include <stdio.h>
#include <unistd.h>
#include <signal.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Video input stream using \ref pw_stream "pw_stream", with format renegotiation.
[title]
*/
#include <stdio.h>
#include <unistd.h>
#include <signal.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Video input stream using \ref pw_stream "pw_stream".
[title]
*/
#include <stdio.h>
#include <unistd.h>
#include <signal.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Allocating buffer memory and sending fds to the server.
[title]
*/
#include "config.h"
#include <stdio.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Renegotiating video producer and consumer formats with \ref pw_stream
[title]
*/
#include "config.h"
#include <stdio.h>

View file

@ -22,6 +22,12 @@
* DEALINGS IN THE SOFTWARE.
*/
/*
[title]
Video source using \ref pw_stream.
[title]
*/
#include <stdio.h>
#include <errno.h>
#include <signal.h>