From 10af59bdc25772c5d8bffcbef3b0841ce194c378 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Thu, 21 Apr 2022 20:22:45 +0200 Subject: [PATCH] modules: update docs --- src/modules/module-loopback.c | 4 ++++ src/modules/module-profiler.c | 22 ++++++++++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/src/modules/module-loopback.c b/src/modules/module-loopback.c index ef6e2fa2c..6b12f77b0 100644 --- a/src/modules/module-loopback.c +++ b/src/modules/module-loopback.c @@ -103,6 +103,10 @@ * } * ] *\endcode + + * ## See also + * + * `pw-loopback` : a tools thats loads the loopback module with given parameters. */ #define NAME "loopback" diff --git a/src/modules/module-profiler.c b/src/modules/module-profiler.c index 0678d35e8..40a2eccad 100644 --- a/src/modules/module-profiler.c +++ b/src/modules/module-profiler.c @@ -42,6 +42,28 @@ #include /** \page page_module_profiler PipeWire Module: Profiler + * + * The profiler module provides a Profiler interface for applications that + * can be used to receive profiling information. + * + * Use tools like pw-top and pw-profiler to collect profiling information + * about the pipewire graph. + * + * ## Example configuration + * + * The module has no arguments and is usually added to the config file of + * the main pipewire daemon. + * + *\code{.unparsed} + * context.modules = [ + * { name = libpipewire-module-profiler } + * ] + *\endcode + * + * ## See also + * + * `pw-top`: a tool to display realtime profiler data + * `pw-profiler`: a tool to collect and render profiler data */ #define NAME "profiler"