Adjust documentation to fit doxygen

Signed-off-by: Amir Hammad <amir.hammad@hotmail.com>

7 files changed, 27 insertions, 14 deletions

diff --git a/include/driver/usbh_device_driver.h b/include/driver/usbh_device_driver.h
index 2c67129..690044c 100644
--- a/include/driver/usbh_device_driver.h
+++ b/include/driver/usbh_device_driver.h
@@ -115,7 +115,10 @@ struct _usbh_packet {
 	/// Device's address
 	int8_t address;
 
-	/// Endpoint type (see USBH_ENDPOINT_TYPE_*)
+	/**
+	 * @brief Endpoint type
+	 * @see USBH_ENDPOINT_TYPE
+	 */
 	uint8_t endpoint_type;
 
 	/// Endpoint number 0..15
@@ -147,17 +150,21 @@ struct _usbh_low_level_driver {
 	 * @brief init initialization routine of the low-level driver
 	 *
 	 *
-	 * This function is called during the initialization of the library(@see usbh_init())
+	 * This function is called during the initialization of the library
+	 *
+	 * @see usbh_init()
 	 */
 	void (*init)(void *drvdata);
 
 	/**
-	 * write - perform a write to a device (@see usbh_packet_t)
+	 * write - perform a write to a device
+	 * @see usbh_packet_t
 	 */
 	void (*write)(void *drvdata, const usbh_packet_t *packet);
 
 	/**
-	 * @brief read - perform a read from a device (@see usbh_packet_t)
+	 * @brief read - perform a read from a device
+	 * @see usbh_packet_t
 	 */
 	void (*read)(void *drvdata, usbh_packet_t *packet);
 
@@ -191,18 +198,17 @@ typedef struct _usbh_generic_data usbh_generic_data_t;
 							arg, __FILE__, __LINE__)
 
 
-/// Hub related functions
+/* Hub related functions */
 
 usbh_device_t *usbh_get_free_device(const usbh_device_t *dev);
 bool usbh_enum_available(void);
 void device_enumeration_start(usbh_device_t *dev);
 
-/// All devices functions
-
-///
+/* All devices functions */
 void usbh_read(usbh_device_t *dev, usbh_packet_t *packet);
 void usbh_write(usbh_device_t *dev, const usbh_packet_t *packet);
-/// Helper functions
+
+/* Helper functions used by device drivers */
 void device_xfer_control_read(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev);
 void device_xfer_control_write(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev);
 
diff --git a/include/usbh_core.h b/include/usbh_core.h
index 2315778..2a36809 100644
--- a/include/usbh_core.h
+++ b/include/usbh_core.h
@@ -77,9 +77,10 @@ struct _usbh_dev_driver {
 	bool (*analyze_descriptor)(void *drvdata, void *descriptor);

 

 	/**

-	 * @brief poll method is called periodically by the library core (@see usbh_poll())

+	 * @brief poll method is called periodically by the library core

 	 * @param[in/out] drvdata is the device driver's private data

 	 * @param[in] time_curr_us current timestamp in microseconds

+	 * @see usbh_poll()

 	 */

 	void (*poll)(void *drvdata, uint32_t time_curr_us);

 

@@ -92,7 +93,8 @@ struct _usbh_dev_driver {
 	void (*remove)(void *drvdata);

 

 	/**

-	 * @brief info - compatibility information about the driver. It is used by the core during device enumeration (@see find_driver())

+	 * @brief info - compatibility information about the driver. It is used by the core during device enumeration

+	 * @see find_driver()

 	 */

 	const usbh_dev_driver_info_t * const info;

 };

diff --git a/include/usbh_driver_ac_midi.h b/include/usbh_driver_ac_midi.h
index c692a64..9bab100 100644
--- a/include/usbh_driver_ac_midi.h
+++ b/include/usbh_driver_ac_midi.h
@@ -44,6 +44,8 @@ typedef void (*midi_write_callback_t)(uint8_t bytes_written);
 /**
  * @brief midi_driver_init initialization routine - this will initialize internal structures of this device driver
  * @param config
+ *
+ * @see midi_config_t
  */
 void midi_driver_init(const midi_config_t *config);
 
diff --git a/include/usbh_driver_gp_xbox.h b/include/usbh_driver_gp_xbox.h
index 32aed8a..d648b90 100644
--- a/include/usbh_driver_gp_xbox.h
+++ b/include/usbh_driver_gp_xbox.h
@@ -67,7 +67,7 @@ typedef struct _gp_xbox_config gp_xbox_config_t;
 
 /**
  * @brief gp_xbox_driver_init initialization routine - this will initialize internal structures of this device driver
- * @param config
+ * @see gp_xbox_config_t
  */
 void gp_xbox_driver_init(const gp_xbox_config_t *config);
 
diff --git a/include/usbh_driver_hid_mouse.h b/include/usbh_driver_hid_mouse.h
index b60046a..4a9f0d3 100644
--- a/include/usbh_driver_hid_mouse.h
+++ b/include/usbh_driver_hid_mouse.h
@@ -42,6 +42,7 @@ typedef struct _hid_mouse_config hid_mouse_config_t;
 /**
  * @brief hid_mouse_driver_init initialization routine - this will initialize internal structures of this device driver
  * @param config
+ * @see hid_mouse_config_t
  */
 void hid_mouse_driver_init(const hid_mouse_config_t *config);
 
diff --git a/src/usbh_driver_hid_mouse.c b/src/usbh_driver_hid_mouse.c
index 5265329..62ba481 100644
--- a/src/usbh_driver_hid_mouse.c
+++ b/src/usbh_driver_hid_mouse.c
@@ -232,8 +232,9 @@ static void read_mouse_in(void *drvdata)
 }
 
 /**
- * @param time_curr_us - monotically rising time (@see usbh_poll())
+ * @param time_curr_us - monotically rising time
  *		unit is microseconds
+ * @see usbh_poll()
  */
 static void poll(void *drvdata, uint32_t time_curr_us)
 {
diff --git a/src/usbh_driver_hub.c b/src/usbh_driver_hub.c
index 7bd58cc..9f061b5 100644
--- a/src/usbh_driver_hub.c
+++ b/src/usbh_driver_hub.c
@@ -764,8 +764,9 @@ static void read_ep1(void *drvdata)
 }

 

 /**

- * @param time_curr_us - monotically rising time (@see usbh_poll())

+ * @param time_curr_us - monotically rising time

  *		unit is microseconds

+ * @see usbh_poll()

  */

 static void poll(void *drvdata, uint32_t time_curr_us)

 {