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.

spa/include/spa/buffer/alloc.h

@@ -29,6 +29,11 @@ extern "C" {
 
 #include <spa/buffer/buffer.h>
 
+/**
+ * \addtogroup spa_buffer
+ * \{
+ */
+
 /** information about the buffer layout */
 struct spa_buffer_alloc_info {
 #define SPA_BUFFER_ALLOC_FLAG_INLINE_META	(1<<0)	/**< add metadata data in the skeleton */
@@ -178,7 +183,7 @@ static inline int spa_buffer_alloc_fill_info(struct spa_buffer_alloc_info *info,
 /**
  * Fill skeleton and data according to the allocation info
  *
- * Use the allocation info to create a \ref struct spa_buffer into
+ * Use the allocation info to create a struct \ref spa_buffer into
  * \a skel_mem and \a data_mem.
  *
  * Depending on the flags given when calling \ref
@@ -186,10 +191,10 @@ static inline int spa_buffer_alloc_fill_info(struct spa_buffer_alloc_info *info,
  * will be referenced in either skel_mem or data_mem.
  *
  * \param info an allocation info
- * \param skel_mem memory to hold the \ref struct spa_buffer and the
+ * \param skel_mem memory to hold the struct \ref spa_buffer and the
  *  pointers to meta, chunk and memory.
  * \param data_mem memory to hold the meta, chunk and memory
- * \return a \ref struct spa_buffer in \a skel_mem
+ * \return a struct \ref spa_buffer in \a skel_mem
  */
 static inline struct spa_buffer *
 spa_buffer_alloc_layout(struct spa_buffer_alloc_info *info,
@@ -262,8 +267,8 @@ spa_buffer_alloc_layout(struct spa_buffer_alloc_info *info,
  *
  * \param info the allocation info for one buffer
  * \param n_buffers the number of buffers to create
- * \param buffer a array with space to hold \a n_buffers pointers to buffers
- * \param skel_mem memory for the \ref struct spa_buffer
+ * \param buffers a array with space to hold \a n_buffers pointers to buffers
+ * \param skel_mem memory for the struct \ref spa_buffer
  * \param data_mem memory for the meta, chunk, memory of the buffer if not
  *		inlined in the skeleton.
  * \return 0 on success.
@@ -299,7 +304,7 @@ spa_buffer_alloc_layout_array(struct spa_buffer_alloc_info *info,
  * \param n_datas number of datas
  * \param datas \a n_datas memory specification
  * \param data_aligns \a n_datas alignment specifications
- * \returns an array of \a n_buffers pointers to \ref struct spa_buffer
+ * \returns an array of \a n_buffers pointers to struct \ref spa_buffer
  *     with the given metadata, data and alignment or NULL when
  *     allocation failed.
  *
@@ -330,6 +335,9 @@ spa_buffer_alloc_array(uint32_t n_buffers, uint32_t flags,
 	return buffers;
 }
 
+/**
+ * \}
+ */
 
 #ifdef __cplusplus
 }  /* extern "C" */

spa/include/spa/buffer/buffer.h

@@ -31,12 +31,17 @@ extern "C" {
 #include <spa/utils/defs.h>
 #include <spa/buffer/meta.h>
 
-/** \page page_buffer Buffers
+/** \defgroup spa_buffer SPA Buffers
  *
  * Buffers describe the data and metadata that is exchanged between
  * ports of a node.
  */
 
+/**
+ * \addtogroup spa_buffer
+ * \{
+ */
+
 enum spa_data_type {
 	SPA_DATA_Invalid,
 	SPA_DATA_MemPtr,		/**< pointer to memory, the data field in
@@ -112,6 +117,10 @@ static inline void *spa_buffer_find_meta_data(const struct spa_buffer *b, uint32
 	return NULL;
 }
 
+/**
+ * \}
+ */
+
 #ifdef __cplusplus
 }  /* extern "C" */
 #endif

spa/include/spa/buffer/meta.h

@@ -32,10 +32,11 @@ extern "C" {
 #include <spa/utils/defs.h>
 #include <spa/pod/pod.h>
 
-/** \page page_meta Metadata
- *
- * Metadata contains extra information on a buffer.
+/**
+ * \addtogroup spa_buffer
+ * \{
  */
+
 enum spa_meta_type {
 	SPA_META_Invalid,
 	SPA_META_Header,	/**< struct spa_meta_header */
@@ -151,6 +152,10 @@ struct spa_meta_busy {
 	uint32_t count;			/**< number of users busy with the buffer */
 };
 
+/**
+ * \}
+ */
+
 #ifdef __cplusplus
 }  /* extern "C" */
 #endif

spa/include/spa/buffer/type-info.h

@@ -25,6 +25,11 @@
 #ifndef SPA_BUFFER_TYPES_H
 #define SPA_BUFFER_TYPES_H
 
+/**
+ * \addtogroup spa_buffer
+ * \{
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -77,6 +82,10 @@ static const struct spa_type_info spa_type_meta_type[] = {
 	{ 0, 0, NULL, NULL },
 };
 
+/**
+ * \}
+ */
+
 #ifdef __cplusplus
 }  /* extern "C" */
 #endif