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,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
/** Various Chroma settings.
*/
enum spa_video_chroma_site {
@ -48,6 +53,10 @@ enum spa_video_chroma_site {
SPA_VIDEO_CHROMA_SITE_DV = (SPA_VIDEO_CHROMA_SITE_COSITED | SPA_VIDEO_CHROMA_SITE_ALT_LINE),
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
/**
* Possible color range values. These constants are defined for 8 bit color
* values and can be scaled for other bit depths.
@ -109,6 +114,10 @@ struct spa_video_colorimetry {
* and CIE XYZ */
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/format.h>
enum spa_h264_stream_format {
@ -58,6 +63,10 @@ struct spa_video_info_mjpg {
struct spa_fraction max_framerate;
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,10 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/pod/parser.h>
#include <spa/pod/builder.h>
#include <spa/param/video/format.h>
@ -168,6 +172,10 @@ spa_format_video_mjpg_parse(const struct spa_pod *format,
SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate));
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/video/raw.h>
#include <spa/param/video/encoded.h>
@ -43,6 +48,10 @@ struct spa_video_info {
} info;
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
/**
* All possible stereoscopic 3D and multiview representations.
* In conjunction with \ref spa_video_multiview_flags, describes how
@ -118,6 +123,10 @@ enum spa_video_multiview_flags {
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/utils/defs.h>
#include <spa/param/video/chroma.h>
#include <spa/param/video/color.h>
@ -189,6 +194,10 @@ struct spa_video_info_dsp {
#define SPA_VIDEO_INFO_DSP_INIT(...) (struct spa_video_info_dsp) { __VA_ARGS__ }
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,10 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/video/raw.h>
#define SPA_TYPE_INFO_VideoFormat SPA_TYPE_INFO_ENUM_BASE "VideoFormat"
@ -117,6 +121,10 @@ static const struct spa_type_info spa_type_video_format[] = {
{ 0, 0, NULL, NULL },
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif