applications: nrf_desktop: Link doxygen API to rst

Ensure that API documented with doxygen is visible in rst files.
Add missing documentation.

Jira: NCSDK-14306

Co-developed-by: divya pillai <[email protected]>
Signed-off-by: divya pillai <[email protected]>
Signed-off-by: Pawel Dunaj <[email protected]>

Author: pdunaj

applications/nrf_desktop/README.rst

@@ -1879,3 +1879,38 @@ Following are the application specific configuration options that can be configu
 
 .. |led_note| replace:: A breathing LED indicates that the device has entered the advertising mode.
    This happens when the device is looking for a peer to connect to.
+
+API documentation
+*****************
+
+Following are the API elements used by the application.
+
+HID reports
+===========
+
+| Header file: :file:`applications/nrf_desktop/configuration/common/hid_report_desc.h`
+| Source file: :file:`applications/nrf_desktop/configuration/common/hid_report_desc.c`
+
+.. doxygengroup:: nrf_desktop_hid_reports
+   :project: nrf
+   :members:
+
+LED states
+==========
+
+| Header file: :file:`applications/nrf_desktop/configuration/common/led_state.h`
+| Source file: :file:`applications/nrf_desktop/src/modules/led_state.c`
+
+.. doxygengroup:: nrf_desktop_led_state
+   :project: nrf
+   :members:
+
+USB events
+==========
+
+| Header file: :file:`applications/nrf_desktop/src/events/usb_event.h`
+| Source file: :file:`applications/nrf_desktop/src/modules/usb_state.c`
+
+.. doxygengroup:: nrf_desktop_usb_event
+   :project: nrf
+   :members:

applications/nrf_desktop/configuration/common/hid_report_desc.h

@@ -4,6 +4,10 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
 
+/** @file
+ * @brief Header file HID report identifiers.
+ */
+
 #ifndef _HID_REPORT_DESC_H_
 #define _HID_REPORT_DESC_H_
 
@@ -23,28 +27,49 @@
 extern "C" {
 #endif
 
+/**
+ * @brief HID Reports
+ * @defgroup nrf_desktop_hid_reports HID Reports
+ * @{
+ */
+
+/** @brief Identification numbers of HID reports. */
 enum report_id {
+	/** Reserved. */
 	REPORT_ID_RESERVED,
 
+	/** Mouse input report. */
 	REPORT_ID_MOUSE,
+	/** Keyboard input report. */
 	REPORT_ID_KEYBOARD_KEYS,
+	/** System control input report. */
 	REPORT_ID_SYSTEM_CTRL,
+	/** Consumer control input report. */
 	REPORT_ID_CONSUMER_CTRL,
 
+	/** Keyboard output report. */
 	REPORT_ID_KEYBOARD_LEDS,
 
+	/** Config channel feature report. */
 	REPORT_ID_USER_CONFIG,
+	/** Config channel output report. */
 	REPORT_ID_USER_CONFIG_OUT,
 
+	/** Reserved. */
 	REPORT_ID_VENDOR_IN,
+	/** Reserved. */
 	REPORT_ID_VENDOR_OUT,
 
+	/** Boot report - mouse. */
 	REPORT_ID_BOOT_MOUSE,
+	/** Boot report - keyboard. */
 	REPORT_ID_BOOT_KEYBOARD,
 
+	/** Number of reports. */
 	REPORT_ID_COUNT
 };
 
+/** @brief Input reports map. */
 static const uint8_t input_reports[] = {
 	REPORT_ID_MOUSE,
 	REPORT_ID_KEYBOARD_KEYS,
@@ -54,6 +79,7 @@ static const uint8_t input_reports[] = {
 	REPORT_ID_BOOT_KEYBOARD,
 };
 
+/** @brief Output reports map. */
 static const uint8_t output_reports[] = {
 	REPORT_ID_KEYBOARD_LEDS,
 };
@@ -62,6 +88,10 @@ static const uint8_t output_reports[] = {
 extern const uint8_t hid_report_desc[];
 extern const size_t hid_report_desc_size;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif

applications/nrf_desktop/configuration/common/led_state.h

@@ -4,45 +4,66 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
 
+/** @file
+ * @brief Header file with LED states.
+ */
+
 #ifndef _LED_STATE_H_
 #define _LED_STATE_H_
 
-/**
- * @brief LED State
- * @defgroup led_state LED State
- * @{
- */
-
 #include <zephyr/types.h>
 #include <caf/events/led_event.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/**
+ * @brief LED State
+ * @defgroup nrf_desktop_led_state LED State
+ * @{
+ */
+
+/** @brief System states represented by LED. */
 enum led_system_state {
+	/** Device is idle. */
 	LED_SYSTEM_STATE_IDLE,
+	/** Device is charging. */
 	LED_SYSTEM_STATE_CHARGING,
+	/** Device in error state. */
 	LED_SYSTEM_STATE_ERROR,
 
+	/** Number of system states. */
 	LED_SYSTEM_STATE_COUNT
 };
 
+/** @brief Peer states represented by LED. */
 enum led_peer_state {
+	/** Peer is disconnected. */
 	LED_PEER_STATE_DISCONNECTED,
+	/** Peer is connected. */
 	LED_PEER_STATE_CONNECTED,
+	/** Device searches for peer. */
 	LED_PEER_STATE_PEER_SEARCH,
+	/** Device waits for user to confirm peer switch. */
 	LED_PEER_STATE_CONFIRM_SELECT,
+	/** Device waits for user to confirm bond erase. */
 	LED_PEER_STATE_CONFIRM_ERASE,
+	/** Device searches for new peer before bond erase. */
 	LED_PEER_STATE_ERASE_ADV,
 
+	/** Number of peer states. */
 	LED_PEER_STATE_COUNT
 };
 
+/** @brief LED identification. */
 enum led_id {
+	/** LED representing system state. */
 	LED_ID_SYSTEM_STATE,
+	/** LED representing peer state. */
 	LED_ID_PEER_STATE,
 
+	/** Number of LEDs. */
 	LED_ID_COUNT
 };
 
@@ -59,12 +80,12 @@ enum led_id {
 #define LED_PEER_COUNT 1
 #endif
 
-#ifdef __cplusplus
-}
-#endif
-
 /**
  * @}
  */
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _LED_STATE_H_ */

applications/nrf_desktop/src/events/usb_event.h

@@ -4,19 +4,13 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
 
+/** @file
+ * @brief USB event header file.
+ */
+
 #ifndef _USB_EVENT_H_
 #define _USB_EVENT_H_
 
-/**
- * @brief USB Event
- * @defgroup usb_event USB Event
- *
- * File defines a set of events used to transmit the information about USB
- * state between the application modules.
- *
- * @{
- */
-
 #include <zephyr/toolchain/common.h>
 
 #include <app_event_manager.h>
@@ -26,40 +20,59 @@
 extern "C" {
 #endif
 
+/**
+ * @brief USB Event
+ * @defgroup nrf_desktop_usb_event USB Event
+ *
+ * File defines a set of events used to transmit the information about USB
+ * state between the application modules.
+ *
+ * @{
+ */
 
 /** @brief Peer states. */
 enum usb_state {
-	USB_STATE_DISCONNECTED, /**< Cable is not attached. */
-	USB_STATE_POWERED,      /**< Cable attached but no communication. */
-	USB_STATE_ACTIVE,       /**< Cable attached and data is exchanged. */
-	USB_STATE_SUSPENDED,    /**< Cable attached but port is suspended. */
+	/** Cable is not attached. */
+	USB_STATE_DISCONNECTED,
+	/** Cable attached but no communication. */
+	USB_STATE_POWERED,
+	/** Cable attached and data is exchanged. */
+	USB_STATE_ACTIVE,
+	/** Cable attached but port is suspended. */
+	USB_STATE_SUSPENDED,
 
-	USB_STATE_COUNT         /**< Number of states. */
+	/** Number of states. */
+	USB_STATE_COUNT
 };
 
 /** @brief USB state event. */
 struct usb_state_event {
-	struct app_event_header header; /**< Event header. */
+	/** Event header. */
+	struct app_event_header header;
 
-	enum usb_state state; /**< State of the USB module. */
+	/** State of the USB module. */
+	enum usb_state state;
 };
 APP_EVENT_TYPE_DECLARE(usb_state_event);
 
 /** @brief USB HID event. */
 struct usb_hid_event {
-	struct app_event_header header; /**< Event header. */
+	/** Event header. */
+	struct app_event_header header;
 
-	const void *id;       /**< USB HID device id. */
+	/** USB HID device id. */
+	const void *id;
+	/** USB HID device enabled state. */
 	bool enabled;
 };
 APP_EVENT_TYPE_DECLARE(usb_hid_event);
 
-#ifdef __cplusplus
-}
-#endif
-
 /**
  * @}
  */
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _USB_EVENT_H_ */