spa: group the spa headers into doxygen modules

Subdirectories buffer, control, debug, monitor, pod, support and utils, others
are still missing. Headers are grouped either per subdirectory (e.g. buffer/
gets added to group spa_buffer) or per-file (e.g. spa_json is a separate
group), whatever seemed like the most sensible approach.
This commit is contained in:
Peter Hutterer 2021-05-21 14:03:07 +10:00 committed by Wim Taymans
parent d0aff793b7
commit 07533cb708
72 changed files with 700 additions and 21 deletions

View file

@ -34,6 +34,15 @@ extern "C" {
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
/** \defgroup spa_support SPA Support Features
*
*/
/**
* \addtogroup spa_support
* \{
*/
/**
* The CPU features interface
*/
@ -142,6 +151,10 @@ struct spa_cpu_methods {
#define SPA_KEY_CPU_FORCE "cpu.force" /**< force cpu flags */
#define SPA_KEY_CPU_VM_TYPE "cpu.vm.type" /**< force a VM type */
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -31,6 +31,11 @@ extern "C" {
#include <spa/support/loop.h>
/**
* \addtogroup spa_support
* \{
*/
#define SPA_TYPE_INTERFACE_DBus SPA_TYPE_INFO_INTERFACE_BASE "DBus"
#define SPA_VERSION_DBUS 0
@ -133,6 +138,10 @@ spa_dbus_get_connection(struct spa_dbus *dbus, enum spa_dbus_type type)
return res;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -32,6 +32,11 @@ extern "C" {
#include <spa/utils/hook.h>
#include <spa/utils/defs.h>
/**
* \addtogroup spa_support
* \{
*/
#define SPA_TYPE_INTERFACE_I18N SPA_TYPE_INFO_INTERFACE_BASE "I18N"
#define SPA_VERSION_I18N 0
@ -86,6 +91,10 @@ spa_i18n_ntext(struct spa_i18n *i18n, const char *msgid,
return res;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -34,6 +34,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/support/log.h>
/**
* \addtogroup spa_log
* \{
*/
static inline SPA_PRINTF_FUNC(6, 0) void spa_log_impl_logv(void *object,
enum spa_log_level level,
const char *file,
@ -87,6 +92,10 @@ struct { \
#define SPA_LOG_IMPL(name) \
SPA_LOG_IMPL_DEFINE(name) = SPA_LOG_IMPL_INIT(name)
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -34,6 +34,14 @@ extern "C" {
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
/** \defgroup spa_log SPA Logging
*/
/**
* \addtogroup spa_log
* \{
*/
enum spa_log_level {
SPA_LOG_LEVEL_NONE = 0,
SPA_LOG_LEVEL_ERROR,
@ -173,6 +181,10 @@ static inline void spa_log_trace_fp (struct spa_log *l, const char *format, ...)
#define SPA_KEY_LOG_TIMESTAMP "log.timestamp" /**< log timestamps */
#define SPA_KEY_LOG_LINE "log.line" /**< log file and line numbers */
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -33,6 +33,11 @@ extern "C" {
#include <spa/utils/hook.h>
#include <spa/support/system.h>
/**
* \addtogroup spa_support
* \{
*/
#define SPA_TYPE_INTERFACE_Loop SPA_TYPE_INFO_INTERFACE_BASE "Loop"
#define SPA_TYPE_INTERFACE_DataLoop SPA_TYPE_INFO_INTERFACE_BASE "DataLoop"
#define SPA_VERSION_LOOP 0
@ -305,6 +310,10 @@ struct spa_loop_utils_methods {
#define spa_loop_utils_add_signal(l,...) spa_loop_utils_method_s(l,add_signal,0,__VA_ARGS__)
#define spa_loop_utils_destroy_source(l,...) spa_loop_utils_method_v(l,destroy_source,0,__VA_ARGS__)
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -32,6 +32,15 @@ extern "C" {
#include <spa/utils/defs.h>
#include <spa/utils/dict.h>
/**
* \defgroup spa_handle SPA Plugin Handles
*/
/**
* \addtogroup spa_handle
* \{
*/
struct spa_handle {
/** Version of this struct */
#define SPA_VERSION_HANDLE 0
@ -208,6 +217,10 @@ int spa_handle_factory_enum(const struct spa_handle_factory **factory, uint32_t
* the filename of the plugin without the
* path or the plugin extension. */
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -37,6 +37,11 @@ struct itimerspec;
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
/**
* \addtogroup spa_support
* \{
*/
/**
* a collection of core system functions
*/
@ -145,6 +150,10 @@ struct spa_system_methods {
#define spa_system_signalfd_create(s,...) spa_system_method_r(s,signalfd_create,0,__VA_ARGS__)
#define spa_system_signalfd_read(s,...) spa_system_method_r(s,signalfd_read,0,__VA_ARGS__)
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif