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

@ -29,6 +29,10 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/pod/parser.h>
#include <spa/pod/builder.h>
@ -106,6 +110,10 @@ spa_format_audio_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct
return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/format.h>
#include <spa/param/audio/raw.h>
@ -41,6 +46,10 @@ struct spa_audio_info {
} info;
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -33,6 +33,10 @@ extern "C" {
#include <endian.h>
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/audio/raw.h>
struct spa_audio_layout_info {
@ -177,6 +181,10 @@ struct spa_audio_layout_info {
SPA_AUDIO_CHANNEL_RL, SPA_AUDIO_CHANNEL_RR, \
SPA_AUDIO_CHANNEL_FLC, SPA_AUDIO_CHANNEL_FRC, }
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -35,6 +35,11 @@ extern "C" {
#include <endian.h>
#endif
/**
* \addtogroup spa_param
* \{
*/
#define SPA_AUDIO_MAX_CHANNELS 64u
enum spa_audio_format {
@ -235,6 +240,10 @@ struct spa_audio_info_dsp {
#define SPA_AUDIO_INFO_DSP_INIT(...) (struct spa_audio_info_dsp) { __VA_ARGS__ }
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/audio/raw.h>
#define SPA_TYPE_INFO_AudioFormat SPA_TYPE_INFO_ENUM_BASE "AudioFormat"
@ -193,6 +198,10 @@ static const struct spa_type_info spa_type_audio_channel[] = {
{ 0, 0, NULL, NULL },
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif