Bluetooth: PACS: Add missing documentation in pacs.h
Add missing documentation for some defintions in pacs.h
Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
diff --git a/include/zephyr/bluetooth/audio/pacs.h b/include/zephyr/bluetooth/audio/pacs.h
index 74f401d..1202328 100644
--- a/include/zephyr/bluetooth/audio/pacs.h
+++ b/include/zephyr/bluetooth/audio/pacs.h
@@ -1,8 +1,10 @@
-/* @file
- * @brief APIs for Audio Capabilities handling
- *
- * Copyright (c) 2021 Intel Corporation
- * Copyright (c) 2021-2022 Nordic Semiconductor ASA
+/**
+ * @file
+ * @brief Bluetooth Published Audio Capabilities Service (PACS) APIs
+ */
+
+/* Copyright (c) 2021 Intel Corporation
+ * Copyright (c) 2021-2024 Nordic Semiconductor ASA
*
* SPDX-License-Identifier: Apache-2.0
*/
@@ -10,6 +12,20 @@
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_PACS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_PACS_H_
+/**
+ * @brief Published Audio Capabilities Service (PACS)
+ *
+ * @defgroup bt_gatt_csip Coordinated Set Identification Profile (CSIP)
+ *
+ * @since 3.0
+ * @version 0.8.0
+ *
+ * @ingroup bluetooth
+ * @{
+ *
+ * The Published Audio Capabilities Service (PACS) is used to expose capabilities to remote devices.
+ */
+
#include <stdbool.h>
#include <zephyr/bluetooth/audio/audio.h>
@@ -25,57 +41,62 @@
/** Codec capability reference */
const struct bt_audio_codec_cap *codec_cap;
- /* Internally used list node */
+ /** @internal Internally used list node */
sys_snode_t _node;
};
-/** @typedef bt_pacs_cap_foreach_func_t
- * @brief Published Audio Capability iterator callback.
+/**
+ * @typedef bt_pacs_cap_foreach_func_t
+ * @brief Published Audio Capability iterator callback.
*
- * @param cap Capability found.
- * @param user_data Data given.
+ * @param cap Capability found.
+ * @param user_data Data given.
*
- * @return true to continue to the next capability
- * @return false to stop the iteration
+ * @return true to continue to the next capability
+ * @return false to stop the iteration
*/
typedef bool (*bt_pacs_cap_foreach_func_t)(const struct bt_pacs_cap *cap,
void *user_data);
-/** @brief Published Audio Capability iterator.
+/**
+ * @brief Published Audio Capability iterator.
*
- * Iterate capabilities with endpoint direction specified.
+ * Iterate capabilities with endpoint direction specified.
*
- * @param dir Direction of the endpoint to look capability for.
- * @param func Callback function.
- * @param user_data Data to pass to the callback.
+ * @param dir Direction of the endpoint to look capability for.
+ * @param func Callback function.
+ * @param user_data Data to pass to the callback.
*/
void bt_pacs_cap_foreach(enum bt_audio_dir dir,
bt_pacs_cap_foreach_func_t func,
void *user_data);
-/** @brief Register Published Audio Capability.
+/**
+ * @brief Register Published Audio Capability.
*
- * Register Audio Local Capability.
+ * Register Audio Local Capability.
*
- * @param dir Direction of the endpoint to register capability for.
- * @param cap Capability structure.
+ * @param dir Direction of the endpoint to register capability for.
+ * @param cap Capability structure.
*
- * @return 0 in case of success or negative value in case of error.
+ * @return 0 in case of success or negative value in case of error.
*/
int bt_pacs_cap_register(enum bt_audio_dir dir, struct bt_pacs_cap *cap);
-/** @brief Unregister Published Audio Capability.
+/**
+ * @brief Unregister Published Audio Capability.
*
- * Unregister Audio Local Capability.
+ * Unregister Audio Local Capability.
*
- * @param dir Direction of the endpoint to unregister capability for.
- * @param cap Capability structure.
+ * @param dir Direction of the endpoint to unregister capability for.
+ * @param cap Capability structure.
*
- * @return 0 in case of success or negative value in case of error.
+ * @return 0 in case of success or negative value in case of error.
*/
int bt_pacs_cap_unregister(enum bt_audio_dir dir, struct bt_pacs_cap *cap);
-/** @brief Set the location for an endpoint type
+/**
+ * @brief Set the location for an endpoint type
*
* @param dir Direction of the endpoints to change location for.
* @param location The location to be set.
@@ -85,7 +106,8 @@
int bt_pacs_set_location(enum bt_audio_dir dir,
enum bt_audio_location location);
-/** @brief Set the available contexts for an endpoint type
+/**
+ * @brief Set the available contexts for an endpoint type
*
* @param dir Direction of the endpoints to change available contexts for.
* @param contexts The contexts to be set.
@@ -95,7 +117,8 @@
int bt_pacs_set_available_contexts(enum bt_audio_dir dir,
enum bt_audio_context contexts);
-/** @brief Get the available contexts for an endpoint type
+/**
+ * @brief Get the available contexts for an endpoint type
*
* @param dir Direction of the endpoints to get contexts for.
*
@@ -103,7 +126,8 @@
*/
enum bt_audio_context bt_pacs_get_available_contexts(enum bt_audio_dir dir);
-/** @brief Set the available contexts for a given connection
+/**
+ * @brief Set the available contexts for a given connection
*
* This function sets the available contexts value for a given @p conn connection object.
* If the @p contexts parameter is NULL the available contexts value is reset to default.
@@ -120,7 +144,8 @@
int bt_pacs_conn_set_available_contexts_for_conn(struct bt_conn *conn, enum bt_audio_dir dir,
enum bt_audio_context *contexts);
-/** @brief Get the available contexts for a given connection
+/**
+ * @brief Get the available contexts for a given connection
*
* This server function returns the available contexts value for a given @p conn connection object.
* The value returned is the one set with @ref bt_pacs_conn_set_available_contexts_for_conn function
@@ -135,7 +160,8 @@
enum bt_audio_context bt_pacs_get_available_contexts_for_conn(struct bt_conn *conn,
enum bt_audio_dir dir);
-/** @brief Set the supported contexts for an endpoint type
+/**
+ * @brief Set the supported contexts for an endpoint type
*
* @param dir Direction of the endpoints to change available contexts for.
* @param contexts The contexts to be set.
@@ -149,4 +175,6 @@
}
#endif
+/** @} */
+
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_PACS_H_ */
