Merge pull request #30 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.6 (2024-12-29)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.5 (2024-12-28)
 
 ## Bug Fixes

project/raspberrypi4b/driver/src/raspberrypi4b_driver_ssd1306_interface.c

@@ -87,10 +87,10 @@ uint8_t ssd1306_interface_iic_deinit(void)
 
 /**
  * @brief     interface iic bus write
- * @param[in] addr is the iic device write address
- * @param[in] reg is the iic register address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of the data buffer
+ * @param[in] addr iic device write address
+ * @param[in] reg iic register address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of the data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -127,8 +127,8 @@ uint8_t ssd1306_interface_spi_deinit(void)
 
 /**
  * @brief     interface spi bus write
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of data buffer
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -141,7 +141,7 @@ uint8_t ssd1306_interface_spi_write_cmd(uint8_t *buf, uint16_t len)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void ssd1306_interface_delay_ms(uint32_t ms)
@@ -151,7 +151,7 @@ void ssd1306_interface_delay_ms(uint32_t ms)
 
 /**
  * @brief     interface print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @note      none
  */
 void ssd1306_interface_debug_print(const char *const fmt, ...)
@@ -195,7 +195,7 @@ uint8_t ssd1306_interface_spi_cmd_data_gpio_deinit(void)
 
 /**
  * @brief     interface command && data gpio write
- * @param[in] value is the written value
+ * @param[in] value written value
  * @return    status code
  *            - 0 success
  *            - 1 gpio write failed
@@ -232,7 +232,7 @@ uint8_t ssd1306_interface_reset_gpio_deinit(void)
 
 /**
  * @brief     interface reset gpio write
- * @param[in] value is the written value
+ * @param[in] value written value
  * @return    status code
  *            - 0 success
  *            - 1 gpio write failed

project/raspberrypi4b/src/client.c

@@ -53,8 +53,13 @@ static int gs_conn_fd;                           /**< network handle */
 static struct sockaddr_in gs_server_addr;        /**< server address */
 
 /**
- * @brief main function
- * @note  none
+ * @brief     main function
+ * @param[in] argc arg numbers
+ * @param[in] **argv arg address
+ * @return    status code
+ *            - 0 success
+ *            - 1 run failed
+ * @note      none
  */
 int main(uint8_t argc, char **argv)
 {

project/raspberrypi4b/src/main.c

@@ -57,8 +57,8 @@ static struct sockaddr_in gs_server_addr;        /**< server address */
 
 /**
  * @brief     ssd1306 full function
- * @param[in] argc is arg numbers
- * @param[in] **argv is the arg address
+ * @param[in] argc arg numbers
+ * @param[in] **argv arg address
  * @return    status code
  *            - 0 success
  *            - 1 run failed
@@ -1104,8 +1104,8 @@ static uint8_t a_socket_init(void)
 
 /**
  * @brief     socket read
- * @param[in] *buf points to a buffer address
- * @param[in] len is the buffer length
+ * @param[in] *buf pointer to a buffer address
+ * @param[in] len buffer length
  * @return    status code
  *             - 0 success
  *             - 1 read failed
@@ -1136,7 +1136,7 @@ static uint16_t a_socket_read(uint8_t *buf, uint16_t len)
 
 /**
  * @brief     signal handler
- * @param[in] signum is the signal number
+ * @param[in] signum signal number
  * @note      none
  */
 static void a_sig_handler(int signum)