doc: fix some doxygen warnings

This commit is contained in:
Pauli Virtanen 2024-01-28 13:06:50 +02:00 committed by Wim Taymans
parent 8e3c0f02b2
commit 978dbff32f
23 changed files with 111 additions and 27 deletions

View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/aac.h>
/**
* \addtogroup spa_param
* \{
*/
#define SPA_TYPE_INFO_AudioAACStreamFormat SPA_TYPE_INFO_ENUM_BASE "AudioAACStreamFormat"
#define SPA_TYPE_INFO_AUDIO_AAC_STREAM_FORMAT_BASE SPA_TYPE_INFO_AudioAACStreamFormat ":"

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_aac_stream_format {
SPA_AUDIO_AAC_STREAM_FORMAT_UNKNOWN,
/* Raw AAC frames */

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_alac {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/amr.h>
/**
* \addtogroup spa_param
* \{
*/
#define SPA_TYPE_INFO_AudioAMRBandMode SPA_TYPE_INFO_ENUM_BASE "AudioAMRBandMode"
#define SPA_TYPE_INFO_AUDIO_AMR_BAND_MODE_BASE SPA_TYPE_INFO_AudioAMRBandMode ":"

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_amr_band_mode {
SPA_AUDIO_AMR_BAND_MODE_UNKNOWN,
SPA_AUDIO_AMR_BAND_MODE_NB,

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_ape {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_dsp {
enum spa_audio_format format; /*< format, one of the DSP formats in enum spa_audio_format */
};

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_flac {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/iec958.h>
/**
* \addtogroup spa_param
* \{
*/
#define SPA_TYPE_INFO_AudioIEC958Codec SPA_TYPE_INFO_ENUM_BASE "AudioIEC958Codec"
#define SPA_TYPE_INFO_AUDIO_IEC958_CODEC_BASE SPA_TYPE_INFO_AudioIEC958Codec ":"

View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/mp3.h>
/**
* \addtogroup spa_param
* \{
*/
#define SPA_TYPE_INFO_AudioMP3ChannelMode SPA_TYPE_INFO_ENUM_BASE "AudioMP3ChannelMode"
#define SPA_TYPE_INFO_AUDIO_MP3_CHANNEL_MODE_BASE SPA_TYPE_INFO_AudioMP3ChannelMode ":"

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_mp3_channel_mode {
SPA_AUDIO_MP3_CHANNEL_MODE_UNKNOWN,
SPA_AUDIO_MP3_CHANNEL_MODE_MONO,

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_opus {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_ra {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_vorbis {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/wma.h>
/**
* \addtogroup spa_param
* \{
*/
#define SPA_TYPE_INFO_AudioWMAProfile SPA_TYPE_INFO_ENUM_BASE "AudioWMAProfile"
#define SPA_TYPE_INFO_AUDIO_WMA_PROFILE_BASE SPA_TYPE_INFO_AudioWMAProfile ":"

View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_wma_profile {
SPA_AUDIO_WMA_PROFILE_UNKNOWN,

View file

@ -10,6 +10,12 @@ extern "C" {
#endif
#include <spa/utils/type.h>
#include <spa/pod/pod.h>
/**
* \addtogroup spa_types
* \{
*/
#define SPA_TYPE_INFO_Direction SPA_TYPE_INFO_ENUM_BASE "Direction"
#define SPA_TYPE_INFO_DIRECTION_BASE SPA_TYPE_INFO_Direction ":"
@ -20,8 +26,6 @@ static const struct spa_type_info spa_type_direction[] = {
{ 0, 0, NULL, NULL }
};
#include <spa/pod/pod.h>
#define SPA_TYPE_INFO_Choice SPA_TYPE_INFO_ENUM_BASE "Choice"
#define SPA_TYPE_INFO_CHOICE_BASE SPA_TYPE_INFO_Choice ":"