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,15 @@
extern "C" {
#endif
/** \defgroup spa_debug SPA Debug
*
*/
/**
* \addtogroup spa_debug
* \{
*/
#include <spa/debug/mem.h>
#include <spa/debug/types.h>
#include <spa/buffer/type-info.h>
@ -112,6 +121,10 @@ static inline int spa_debug_buffer(int indent, const struct spa_buffer *buffer)
return 0;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_debug
* \{
*/
#include <spa/utils/dict.h>
#ifndef spa_debug
@ -45,6 +50,10 @@ static inline int spa_debug_dict(int indent, const struct spa_dict *dict)
return 0;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_debug
* \{
*/
#include <spa/pod/parser.h>
#include <spa/debug/types.h>
#include <spa/param/type-info.h>
@ -195,6 +200,10 @@ static inline int spa_debug_format(int indent,
return 0;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_debug
* \{
*/
#include <spa/utils/dict.h>
#ifndef spa_debug
@ -53,6 +58,10 @@ static inline int spa_debug_mem(int indent, const void *data, size_t size)
return 0;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_debug
* \{
*/
#include <spa/node/node.h>
#include <spa/debug/dict.h>
@ -49,6 +54,10 @@ static inline int spa_debug_port_info(int indent, const struct spa_port_info *in
return 0;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_debug
* \{
*/
#include <spa/debug/mem.h>
#include <spa/debug/types.h>
#include <spa/pod/pod.h>
@ -201,6 +206,11 @@ static inline int spa_debug_pod(int indent,
SPA_POD_BODY_SIZE(pod));
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_debug
* \{
*/
#include <spa/utils/type-info.h>
#include <string.h>
@ -91,6 +96,10 @@ static inline uint32_t spa_debug_type_find_type(const struct spa_type_info *info
return SPA_ID_INVALID;
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif