treewide: replace kconfig docs macro

This patch makes the now broken KConfig mentions in docs look slightly
better.

Signed-off-by: Maximilian Deubel <[email protected]>

applications/nrf_desktop/src/util/hid_reportq.h

@@ -61,7 +61,7 @@ const void *hid_reportq_get_sub_id(struct hid_reportq *q);
  * The function returns an error if HID report subscription is disabled for the added HID report.
  *
  * If number of enqueued reports with a given report ID exceeds limit defined by the configuration
- * (@kconfig{CONFIG_DESKTOP_HID_REPORTQ_MAX_ENQUEUED_REPORTS}), the oldest enqueued HID report with
+ * (`CONFIG_DESKTOP_HID_REPORTQ_MAX_ENQUEUED_REPORTS`), the oldest enqueued HID report with
  * the ID is dropped.
  *
  * @param[in] q		Pointer to the queue instance.

include/app_event_manager.h

@@ -217,7 +217,7 @@ static inline bool app_event_get_type_flag(const struct event_type *et,
  * Function that calculates the event size using its header.
  * @note
  * For this function to be available the
- * @kconfig{CONFIG_APP_EVENT_MANAGER_PROVIDE_EVENT_SIZE} option needs to be enabled.
+ * `CONFIG_APP_EVENT_MANAGER_PROVIDE_EVENT_SIZE` option needs to be enabled.
  *
  * @param aeh Pointer to the application event header.
  *

include/bl_storage.h

@@ -225,7 +225,7 @@ int get_monotonic_counter(uint16_t counter_desc, counter_t *counter_value);
  * @retval -EINVAL  @p new_counter is invalid (must be larger than current
  *                  counter, and cannot be 0xFFFF).
  * @retval -ENOMEM  There are no more free counter slots (see
- *                  @kconfig{CONFIG_SB_NUM_VER_COUNTER_SLOTS}).
+ *                  `CONFIG_SB_NUM_VER_COUNTER_SLOTS`).
  */
 int set_monotonic_counter(uint16_t counter_desc, counter_t new_counter);
 

include/bl_validation.h

@@ -41,7 +41,7 @@ bool (*bl_validate_firmware_t)(uint32_t fw_dst_address, uint32_t fw_src_address)
 /** Whether bl_validate_firmware() is available.
  *
  * @details This is only relevant when
- *          @kconfig{CONFIG_BL_VALIDATE_FW_EXT_API_OPTIONAL} is set.
+ *          `CONFIG_BL_VALIDATE_FW_EXT_API_OPTIONAL` is set.
  *
  * @retval true  bl_validate_firmware() can be called and should work correctly.
  * @retval false bl_validate_firmware() is unavailable and will always return

include/bluetooth/adv_prov.h

@@ -48,7 +48,7 @@ struct bt_le_adv_prov_adv_state {
 	bool new_adv_session;
 
 	/** Information about the advertising set for which the advertising data is prepared.
-	 *  If @kconfig{CONFIG_BT_EXT_ADV} is used, the advertising handle can be acquired using
+	 *  If `CONFIG_BT_EXT_ADV` is used, the advertising handle can be acquired using
 	 *  the bt_hci_get_adv_handle function.
 	 *  Otherwise, the advertising handle must be set to 0.
 	 */

include/bluetooth/adv_prov/fast_pair.h

@@ -31,7 +31,7 @@ void bt_le_adv_prov_fast_pair_enable(bool enable);
 
 /** Show/hide UI indication in Fast Pair not discoverable advertising.
  *
- * This API is only available when the @kconfig{CONFIG_BT_FAST_PAIR_SUBSEQUENT_PAIRING}
+ * This API is only available when the `CONFIG_BT_FAST_PAIR_SUBSEQUENT_PAIRING`
  * Kconfig option is enabled. With this Kconfig option disabled, UI indications are always
  * hidden.
  *
@@ -46,7 +46,7 @@ void bt_le_adv_prov_fast_pair_show_ui_pairing(bool enable);
 
 /** Set advertising battery mode in Fast Pair not dicoverable advertising.
  *
- * This API can only be used when the @kconfig{CONFIG_BT_FAST_PAIR_BN} Kconfig option is enabled.
+ * This API can only be used when the `CONFIG_BT_FAST_PAIR_BN` Kconfig option is enabled.
  * With this Kconfig option disabled, battery data is not included in the advertising packet.
  *
  * To prevent tracking, the Fast Pair Provider should not include battery data in the advertising

include/bluetooth/mesh/gen_prop_srv.h

@@ -30,7 +30,7 @@ struct bt_mesh_prop_srv;
  * @param[in] _properties Array of properties supported by the server.
  * @param[in] _property_count Number of properties supported by the server.
  *                            Cannot be larger than
- *                            @kconfig{CONFIG_BT_MESH_PROP_MAXCOUNT}.
+ *                            `CONFIG_BT_MESH_PROP_MAXCOUNT`.
  * @param[in] _get Getter handler for property values. @sa
  * bt_mesh_prop_srv::get.
  * @param[in] _set Setter handler for property values. @sa

include/bluetooth/mesh/light_ctrl_srv.h

@@ -34,7 +34,7 @@ struct bt_mesh_light_ctrl_srv;
  *
  *  @brief Initialization parameters for @ref bt_mesh_light_ctrl_srv with custom regulator.
  *
- *  Only available if @kconfig{CONFIG_BT_MESH_LIGHT_CTRL_SRV_REG} is selected.
+ *  Only available if `CONFIG_BT_MESH_LIGHT_CTRL_SRV_REG` is selected.
  *
  *  @param[in] _lightness_srv Pointer to the @ref bt_mesh_lightness_srv this
  *                            server controls.
@@ -55,8 +55,8 @@ struct bt_mesh_light_ctrl_srv;
  *  @brief Initialization parameters for @ref bt_mesh_light_ctrl_srv.
  *
  *  This will enable the specification-defined regulator if
- *  @kconfig{CONFIG_BT_MESH_LIGHT_CTRL_SRV_REG} and
- *  @kconfig{CONFIG_BT_MESH_LIGHT_CTRL_REG_SPEC} are selected.
+ *  `CONFIG_BT_MESH_LIGHT_CTRL_SRV_REG` and
+ *  `CONFIG_BT_MESH_LIGHT_CTRL_REG_SPEC` are selected.
  *
  *  @param[in] _lightness_srv Pointer to the @ref bt_mesh_lightness_srv this
  *                            server controls.
@@ -226,7 +226,7 @@ int bt_mesh_light_ctrl_srv_on(struct bt_mesh_light_ctrl_srv *srv);
  *  state). Calling this function temporarily disables occupancy sensor
  *  triggering (referred to as "manual mode" in the documentation). The server
  *  will remain in manual mode until the manual mode timer expires, see
- *  @kconfig{CONFIG_BT_MESH_LIGHT_CTRL_SRV_TIME_MANUAL}.
+ *  `CONFIG_BT_MESH_LIGHT_CTRL_SRV_TIME_MANUAL`.
  *
  *  @param[in] srv        Light Lightness Control Server instance.
  *

include/bluetooth/mesh/sensor.h

@@ -829,7 +829,7 @@ bool bt_mesh_sensor_value_in_column(const struct bt_mesh_sensor_value *value,
 /** @brief Get a human readable representation of a single sensor channel.
  *
  *  @note This prints float values internally for most formats, which requires
- *  @kconfig{CONFIG_CBPRINTF_FP_SUPPORT} to be enabled.
+ *  `CONFIG_CBPRINTF_FP_SUPPORT` to be enabled.
  *
  *  @param[in]  ch  Sensor channel to represent.
  *  @param[out] str String buffer to fill. Should be @ref
@@ -845,7 +845,7 @@ int bt_mesh_sensor_ch_to_str(const struct bt_mesh_sensor_value *ch, char *str,
 /** @brief Get a human readable representation of a single sensor channel.
  *
  *  @note This prints float values internally for most formats, which requires
- *  @kconfig{CONFIG_CBPRINTF_FP_SUPPORT} to be enabled.
+ *  `CONFIG_CBPRINTF_FP_SUPPORT` to be enabled.
  *
  *  @note This function is not thread safe.
  *
@@ -859,7 +859,7 @@ const char *bt_mesh_sensor_ch_str(const struct bt_mesh_sensor_value *ch);
  *
  *  Only known sensor types from @ref bt_mesh_sensor_types will be available.
  *  Sensor types can be made known to the sensor module by enabling
- *  @kconfig{CONFIG_BT_MESH_SENSOR_ALL_TYPES} or by referencing them in the
+ *  `CONFIG_BT_MESH_SENSOR_ALL_TYPES` or by referencing them in the
  *  application.
  *
  *  @param[in] id A Device Property ID.

include/bluetooth/mesh/sensor_srv.h

@@ -30,7 +30,7 @@ struct bt_mesh_sensor_srv;
  *
  *  @param[in] _sensors Array of pointers to sensors owned by this server.
  *  @param[in] _count Number of sensors in the array. Can at most be
- *                    @kconfig{CONFIG_BT_MESH_SENSOR_SRV_SENSORS_MAX}.
+ *                    `CONFIG_BT_MESH_SENSOR_SRV_SENSORS_MAX`.
  */
 #define BT_MESH_SENSOR_SRV_INIT(_sensors, _count)                              \
 	{                                                                      \

include/bluetooth/services/fast_pair/fast_pair.h

@@ -14,7 +14,7 @@
  * @brief Fast Pair API
  *
  * The Fast Pair subsystem needs the Bluetooth GATT operations to be run from the cooperative
- * thread context. It requires proper configuration of the @kconfig{CONFIG_BT_RECV_CONTEXT}
+ * thread context. It requires proper configuration of the `CONFIG_BT_RECV_CONTEXT`
  * Kconfig option.
  *
  * @{
@@ -26,7 +26,7 @@ extern "C" {
 
 /** Value that denotes unknown battery level (see @ref bt_fast_pair_battery).
  *
- * Used only when the @kconfig{CONFIG_BT_FAST_PAIR_BN} Kconfig option is enabled.
+ * Used only when the `CONFIG_BT_FAST_PAIR_BN` Kconfig option is enabled.
  */
 #define BT_FAST_PAIR_BATTERY_LEVEL_UNKNOWN	0x7f
 
@@ -45,7 +45,7 @@ enum bt_fast_pair_adv_mode {
 /** @brief Fast Pair not discoverable advertising type. Used to generate advertising packet. */
 enum bt_fast_pair_not_disc_adv_type {
 	/** Show UI indication.
-	 *  Used only when the @kconfig{CONFIG_BT_FAST_PAIR_SUBSEQUENT_PAIRING} is enabled.
+	 *  Used only when the `CONFIG_BT_FAST_PAIR_SUBSEQUENT_PAIRING` is enabled.
 	 */
 	BT_FAST_PAIR_NOT_DISC_ADV_TYPE_SHOW_UI_IND,
 
@@ -58,7 +58,7 @@ enum bt_fast_pair_not_disc_adv_type {
 
 /** @brief Fast Pair advertising battery mode. Used to generate advertising packet.
  *
- * Used only when the @kconfig{CONFIG_BT_FAST_PAIR_BN} Kconfig option is enabled.
+ * Used only when the `CONFIG_BT_FAST_PAIR_BN` Kconfig option is enabled.
  *
  * Battery data can be included in advertising packet only if the Fast Pair Provider is in Fast Pair
  * not discoverable advertising mode and is in possession of at least one Account Key. To prevent
@@ -81,7 +81,7 @@ enum bt_fast_pair_adv_battery_mode {
 
 /** @brief Index of Fast Pair battery component.
  *
- * Used only when the @kconfig{CONFIG_BT_FAST_PAIR_BN} Kconfig option is enabled.
+ * Used only when the `CONFIG_BT_FAST_PAIR_BN` Kconfig option is enabled.
  */
 enum bt_fast_pair_battery_comp {
 	/** Left bud. */
@@ -110,7 +110,7 @@ struct bt_fast_pair_not_disc_adv_info {
 	/** Fast Pair advertising battery mode. Battery values can be set using
 	 *  @ref bt_fast_pair_battery_set.
 	 *
-	 *  This field is used only when the @kconfig{CONFIG_BT_FAST_PAIR_BN} Kconfig option is
+	 *  This field is used only when the `CONFIG_BT_FAST_PAIR_BN` Kconfig option is
 	 *  enabled. Otherwise, it should be set to @ref BT_FAST_PAIR_ADV_BATTERY_MODE_NONE or
 	 *  zero.
 	 */
@@ -140,7 +140,7 @@ struct bt_fast_pair_adv_config {
 
 /** @brief Fast Pair battery component descriptor.
  *
- * Used only when the @kconfig{CONFIG_BT_FAST_PAIR_BN} Kconfig option is enabled.
+ * Used only when the `CONFIG_BT_FAST_PAIR_BN` Kconfig option is enabled.
  */
 struct bt_fast_pair_battery {
 	/** Battery status. True means that battery is charging and False means that battery is not
@@ -281,7 +281,7 @@ bool bt_fast_pair_has_account_key(void);
  * responsibility to update battery value and regenerate advertising packet when battery value
  * change.
  *
- * This function can only be used only when the @kconfig{CONFIG_BT_FAST_PAIR_BN} Kconfig option is
+ * This function can only be used only when the `CONFIG_BT_FAST_PAIR_BN` Kconfig option is
  * enabled.
  *
  * @param[in] battery_comp	Battery component.

include/bluetooth/services/fast_pair/fmdn.h

@@ -36,13 +36,13 @@ enum bt_fast_pair_fmdn_ring_src {
 
 	/** Ringing source type originating from the Bluetooth accessory non-owner
 	 *  service that is defined in the DULT specification.
-	 *  Used only when the @kconfig{CONFIG_BT_FAST_PAIR_FMDN_DULT} is enabled.
+	 *  Used only when the `CONFIG_BT_FAST_PAIR_FMDN_DULT` is enabled.
 	 */
 	BT_FAST_PAIR_FMDN_RING_SRC_DULT_BT_GATT,
 
 	/** Ringing source type originating from the Motion detector defined in the
 	 *  DULT specification.
-	 *  Used only when the @kconfig{CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR}
+	 *  Used only when the `CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR`
 	 *  is enabled.
 	 */
 	BT_FAST_PAIR_FMDN_RING_SRC_DULT_MOTION_DETECTOR,
@@ -157,9 +157,9 @@ struct bt_fast_pair_fmdn_ring_cb {
 	 *
 	 *  This callback is executed in the cooperative thread context. You
 	 *  can learn about the exact thread context by analyzing the
-	 *  @kconfig{CONFIG_BT_RECV_CONTEXT} configuration choice. By default, this
+	 *  `CONFIG_BT_RECV_CONTEXT` configuration choice. By default, this
 	 *  callback is executed in the Bluetooth-specific workqueue thread
-	 *  (@kconfig{CONFIG_BT_RECV_WORKQ_BT}).
+	 *  (`CONFIG_BT_RECV_WORKQ_BT`).
 	 *
 	 *  @param src   Source of the ringing activity.
 	 *  @param param Requested ringing parameters.
@@ -217,9 +217,9 @@ struct bt_fast_pair_fmdn_ring_cb {
 	 *
 	 *  This callback is executed in the cooperative thread context. You
 	 *  can learn about the exact thread context by analyzing the
-	 *  @kconfig{CONFIG_BT_RECV_CONTEXT} configuration choice. By default, this
+	 *  `CONFIG_BT_RECV_CONTEXT` configuration choice. By default, this
 	 *  callback is executed in the Bluetooth-specific workqueue thread
-	 *  (@kconfig{CONFIG_BT_RECV_WORKQ_BT}).
+	 *  (`CONFIG_BT_RECV_WORKQ_BT`).
 	 *
 	 *  @param src Source of the ringing activity.
 	 */
@@ -229,7 +229,7 @@ struct bt_fast_pair_fmdn_ring_cb {
 /** @brief Register the ringing callbacks in the FMDN module.
  *
  *  This function registers the ringing callbacks. If you declare at least one
- *  ringing component using the @kconfig{CONFIG_BT_FAST_PAIR_FMDN_RING_COMP} Kconfig
+ *  ringing component using the `CONFIG_BT_FAST_PAIR_FMDN_RING_COMP` Kconfig
  *  choice option, you shall call this API before you enable Fast Pair with the
  *  @ref bt_fast_pair_enable function. Otherwise, the enable operation fails.
  *
@@ -309,7 +309,7 @@ int bt_fast_pair_fmdn_ring_state_update(
 
 /** @brief Motion detector callback structure.
  *
- *  Used only if the @kconfig{CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR} Kconfig option
+ *  Used only if the `CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR` Kconfig option
  *  is enabled.
  */
 struct bt_fast_pair_fmdn_motion_detector_cb {
@@ -352,7 +352,7 @@ struct bt_fast_pair_fmdn_motion_detector_cb {
  *
  *  This function registers callbacks to handle motion detector activities defined
  *  in the Motion detector feature from the DULT specification. This API can
- *  only be used when the @kconfig{CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR}
+ *  only be used when the `CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR`
  *  Kconfig option is enabled. If this configuration is active, this function must
  *  be called before you enable Fast Pair with the @ref bt_fast_pair_enable function.
  *  Otherwise, the enable operation fails.
@@ -384,7 +384,7 @@ int bt_fast_pair_fmdn_motion_detector_cb_register(
  *  If you do not want to support the battery level indication, you should
  *  ignore this API and never call it in their application.
  *
- *  However, if the @kconfig{CONFIG_BT_FAST_PAIR_FMDN_BATTERY_DULT} Kconfig is enabled,
+ *  However, if the `CONFIG_BT_FAST_PAIR_FMDN_BATTERY_DULT` Kconfig is enabled,
  *  you must initialize battery level with this API before you enable Fast Pair
  *  with the @ref bt_fast_pair_enable API. This requirement is necessary as the
  *  DULT battery mechanism does not support unknown battery levels. As a result,
@@ -398,8 +398,8 @@ int bt_fast_pair_fmdn_motion_detector_cb_register(
  *  The exact mapping of the battery percentage to the battery level as defined by the
  *  FMDN Accessory specification in the advertising payload is implementation-specific.
  *  The mapping configuration is controlled by the following Kconfig options:
- *  @kconfig{CONFIG_BT_FAST_PAIR_FMDN_BATTERY_LEVEL_LOW_THR} and
- *  @kconfig{CONFIG_BT_FAST_PAIR_FMDN_BATTERY_LEVEL_CRITICAL_THR}.
+ *  `CONFIG_BT_FAST_PAIR_FMDN_BATTERY_LEVEL_LOW_THR` and
+ *  `CONFIG_BT_FAST_PAIR_FMDN_BATTERY_LEVEL_CRITICAL_THR`.
  *
  *  @param percentage_level Battery level as a percentage [0-100%] or
  *                          @ref BT_FAST_PAIR_FMDN_BATTERY_LEVEL_NONE value if the
@@ -500,9 +500,9 @@ struct bt_fast_pair_fmdn_info_cb {
 	 *
 	 *  This callback is executed in the cooperative thread context. You
 	 *  can learn about the exact thread context by analyzing the
-	 *  @kconfig{CONFIG_BT_RECV_CONTEXT} configuration choice. By default, this
+	 *  `CONFIG_BT_RECV_CONTEXT` configuration choice. By default, this
 	 *  callback is executed in the Bluetooth-specific workqueue thread
-	 *  (@kconfig{CONFIG_BT_RECV_WORKQ_BT}).
+	 *  (`CONFIG_BT_RECV_WORKQ_BT`).
 	 */
 	void (*clock_synced)(void);
 
@@ -517,9 +517,9 @@ struct bt_fast_pair_fmdn_info_cb {
 	 *  The first callback is executed in the workqueue context after the
 	 *  @ref bt_fast_pair_enable function call. Subsequent callbacks are
 	 *  also executed in the cooperative thread context. You can learn about
-	 *  the exact thread context by analyzing the @kconfig{CONFIG_BT_RECV_CONTEXT}
+	 *  the exact thread context by analyzing the `CONFIG_BT_RECV_CONTEXT`
 	 *  configuration choice. By default, this callback is executed in the
-	 *  Bluetooth-specific workqueue thread (@kconfig{CONFIG_BT_RECV_WORKQ_BT}).
+	 *  Bluetooth-specific workqueue thread (`CONFIG_BT_RECV_WORKQ_BT`).
 	 *
 	 *  @param provisioned true if the accessory has been successfully provisioned.
 	 *                     false if the accessory has been successfully unprovisioned.
@@ -552,7 +552,7 @@ enum bt_fast_pair_fmdn_read_mode {
 	BT_FAST_PAIR_FMDN_READ_MODE_FMDN_RECOVERY,
 
 	/** Identification read mode.
-	 *  Used only when the @kconfig{CONFIG_BT_FAST_PAIR_FMDN_DULT} is enabled.
+	 *  Used only when the `CONFIG_BT_FAST_PAIR_FMDN_DULT` is enabled.
 	 */
 	BT_FAST_PAIR_FMDN_READ_MODE_DULT_ID,
 };

include/dult.h

@@ -109,9 +109,9 @@ int dult_user_register(const struct dult_user *user);
  *
  *  This function sets the current battery level. The battery level is an optional
  *  feature in the DULT specification and this API must not be used when the
- *  @kconfig{CONFIG_DULT_BATTERY} Kconfig is disabled.
+ *  `CONFIG_DULT_BATTERY` Kconfig is disabled.
  *
- *  If the @kconfig{CONFIG_DULT_BATTERY} Kconfig is enabled, this function must be called to
+ *  If the `CONFIG_DULT_BATTERY` Kconfig is enabled, this function must be called to
  *  initialize the battery level after registering the DULT user with @ref dult_user_register
  *  and before enabling DULT with @ref dult_enable function. Subsequent calls to update
  *  the battery level are allowed in the enabled mode.
@@ -122,8 +122,8 @@ int dult_user_register(const struct dult_user *user);
  *  The exact mapping of the battery percentage to the battery level as defined by the
  *  DULT specification in the ANOS is implementation-specific. The mapping configuration
  *  is controlled by the following Kconfig options:
- *  @kconfig{CONFIG_DULT_BATTERY_LEVEL_CRITICAL_THR}, @kconfig{CONFIG_DULT_BATTERY_LEVEL_LOW_THR}
- *  and @kconfig{CONFIG_DULT_BATTERY_LEVEL_MEDIUM_THR}.
+ *  `CONFIG_DULT_BATTERY_LEVEL_CRITICAL_THR}, @kconfig{CONFIG_DULT_BATTERY_LEVEL_LOW_THR`
+ *  and `CONFIG_DULT_BATTERY_LEVEL_MEDIUM_THR`.
  *
  *  @param user	            User structure used to authenticate the user.
  *  @param percentage_level Battery level as a percentage [0-100%]
@@ -193,7 +193,7 @@ enum dult_sound_src {
 	DULT_SOUND_SRC_BT_GATT,
 
 	/** Sound source type originating from the Motion detector.
-	 *  Used only when the @kconfig{CONFIG_DULT_MOTION_DETECTOR} is enabled.
+	 *  Used only when the `CONFIG_DULT_MOTION_DETECTOR` is enabled.
 	 */
 	DULT_SOUND_SRC_MOTION_DETECTOR,
 
@@ -290,7 +290,7 @@ int dult_sound_state_update(const struct dult_user *user,
 
 /** @brief Motion detector callback structure.
  *
- *  Used only when the @kconfig{CONFIG_DULT_MOTION_DETECTOR} Kconfig option is enabled.
+ *  Used only when the `CONFIG_DULT_MOTION_DETECTOR` Kconfig option is enabled.
  */
 struct dult_motion_detector_cb {
 	/** @brief Request the user to start the motion detector.
@@ -332,7 +332,7 @@ struct dult_motion_detector_cb {
  *
  *  This function registers callbacks to handle motion detector activities defined
  *  in the Motion detector feature from the DULT specification. This API can only
- *  be used when the @kconfig{CONFIG_DULT_MOTION_DETECTOR} Kconfig option is
+ *  be used when the `CONFIG_DULT_MOTION_DETECTOR` Kconfig option is
  *  enabled. If this configuration is active, this function must be called after
  *  registering the DULT user with @ref dult_user_register and before enabling
  *  DULT with @ref dult_enable function.