Merge pull request #10 from libdriver/dev

fix: fix doc errors
libdriver · Jan 2, 2025 · 2c70495 · 2c70495
2 parents 76279b0 + ca830e4
commit 2c70495
Show file tree

Hide file tree

Showing 17 changed files with 890 additions and 879 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.3 (2025-01-01)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.2 (2024-10-01)
 
 ## Bug Fixes

diff --git a/doc/html/group__st7789__advance__driver.html b/doc/html/group__st7789__advance__driver.html
diff --git a/doc/html/group__st7789__basic__driver.html b/doc/html/group__st7789__basic__driver.html
diff --git a/doc/html/group__st7789__extend__driver.html b/doc/html/group__st7789__extend__driver.html
@@ -135,8 +135,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga44aea1224c9bfd7adffb071
 <p>write the command </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>is the send command </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>sent command </td></tr>
   </table>
   </dd>
 </dl>
@@ -182,8 +182,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga09f034d3d416582575f59f1
 <p>write the data </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>is the send data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>sent data </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__st7789__interface__driver.html b/doc/html/group__st7789__interface__driver.html
@@ -208,7 +208,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga46a322445592dc637aa9700
 <p>interface command &amp;&amp; data gpio write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>is the written value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>written value </td></tr>
   </table>
   </dd>
 </dl>
@@ -252,7 +252,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3e0078b7d5e3cc56dc15f2b
 <p>interface print format data </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>is the format data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>format data </td></tr>
   </table>
   </dd>
 </dl>
@@ -281,7 +281,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8343f801b954deb919008da
 <p>interface delay ms </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td></td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td>time </td></tr>
   </table>
   </dd>
 </dl>
@@ -366,7 +366,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab084f76d6f72dc7ae8427ad
 <p>interface reset gpio write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>is the written value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>written value </td></tr>
   </table>
   </dd>
 </dl>
@@ -466,8 +466,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadc70aa176dd1359b0432927
 <p>interface spi bus write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the length of data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of data buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__st7789__link__driver.html b/doc/html/group__st7789__link__driver.html
@@ -165,8 +165,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacd7a8704914258f78ea9196
 <p>link cmd_data_gpio_deinit function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a cmd_data_gpio_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a cmd_data_gpio_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -205,8 +205,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf231d615e30cc7ceddba8fd
 <p>link cmd_data_gpio_init function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a cmd_data_gpio_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a cmd_data_gpio_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -245,8 +245,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad5cfadd80617c2653788986
 <p>link cmd_data_gpio_write function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a cmd_data_gpio_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a cmd_data_gpio_write function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -285,8 +285,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0e149a2c2f991b3db28cd8c
 <p>link debug_print function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a debug_print function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a debug_print function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -325,8 +325,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3723547972f57a7969dacf0
 <p>link delay_ms function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a delay_ms function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a delay_ms function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -365,8 +365,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaed138e1e75e16ed1efe2713
 <p>initialize st7789_handle_t structure </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is st7789_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>st7789_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -405,8 +405,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaafd1b68a2a1c084d2c1ea59
 <p>link reset_gpio_deinit function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a reset_gpio_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a reset_gpio_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -445,8 +445,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga54bfc21a8743ebdbf776cad
 <p>link reset_gpio_init function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a reset_gpio_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a reset_gpio_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -485,8 +485,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0658f43d0327f742a1cfdd9
 <p>link reset_gpio_write function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a reset_gpio_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a reset_gpio_write function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -525,8 +525,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf13473665da4300c6bb92df
 <p>link spi_deinit function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -565,8 +565,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1b4e34700642363145b2879
 <p>link spi_init function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -605,8 +605,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6f94337213f3c8d6474053a
 <p>link spi_write_cmd function </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>points to an st7789 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_write_cmd function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an st7789 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_write_cmd function address </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/example/driver_st7789_basic.c b/example/driver_st7789_basic.c
@@ -700,12 +700,12 @@ uint8_t st7789_basic_display_off(void)
 
 /**
  * @brief     basic example draw a string
- * @param[in] x is the coordinate x
- * @param[in] y is the coordinate y
- * @param[in] *str points to a written string address
- * @param[in] len is the length of the string
- * @param[in] color is the display color
- * @param[in] font is the display font size
+ * @param[in] x coordinate x
+ * @param[in] y coordinate y
+ * @param[in] *str pointer to a written string address
+ * @param[in] len length of the string
+ * @param[in] color display color
+ * @param[in] font display font size
  * @return    status code
  *            - 0 success
  *            - 1 draw string failed
@@ -724,9 +724,9 @@ uint8_t st7789_basic_string(uint16_t x, uint16_t y, char *str, uint16_t len, uin
 
 /**
  * @brief     basic example write a point
- * @param[in] x is the coordinate x
- * @param[in] y is the coordinate y
- * @param[in] color is the written color
+ * @param[in] x coordinate x
+ * @param[in] y coordinate y
+ * @param[in] color written color
  * @return    status code
  *            - 0 success
  *            - 1 write point failed
@@ -745,11 +745,11 @@ uint8_t st7789_basic_write_point(uint16_t x, uint16_t y, uint32_t color)
 
 /**
  * @brief     basic example fill a rectangle
- * @param[in] left is the left coordinate x
- * @param[in] top is the top coordinate y
- * @param[in] right is the right coordinate x
- * @param[in] bottom is the bottom coordinate y
- * @param[in] color is the display color
+ * @param[in] left left coordinate x
+ * @param[in] top top coordinate y
+ * @param[in] right right coordinate x
+ * @param[in] bottom bottom coordinate y
+ * @param[in] color display color
  * @return    status code
  *            - 0 success
  *            - 1 fill rect failed
@@ -768,11 +768,11 @@ uint8_t st7789_basic_rect(uint16_t left, uint16_t top, uint16_t right, uint16_t
 
 /**
  * @brief     basic example draw a 16 bits picture
- * @param[in] left is the left coordinate x
- * @param[in] top is the top coordinate y
- * @param[in] right is the right coordinate x
- * @param[in] bottom is the bottom coordinate y
- * @param[in] *img points to a image buffer
+ * @param[in] left left coordinate x
+ * @param[in] top top coordinate y
+ * @param[in] right right coordinate x
+ * @param[in] bottom bottom coordinate y
+ * @param[in] *img pointer to a image buffer
  * @return    status code
  *            - 0 success
  *            - 1 draw picture 16 bits failed

diff --git a/example/driver_st7789_basic.h b/example/driver_st7789_basic.h
@@ -195,12 +195,12 @@ uint8_t st7789_basic_display_off(void);
 
 /**
  * @brief     basic example draw a string
- * @param[in] x is the coordinate x
- * @param[in] y is the coordinate y
- * @param[in] *str points to a written string address
- * @param[in] len is the length of the string
- * @param[in] color is the display color
- * @param[in] font is the display font size
+ * @param[in] x coordinate x
+ * @param[in] y coordinate y
+ * @param[in] *str pointer to a written string address
+ * @param[in] len length of the string
+ * @param[in] color display color
+ * @param[in] font display font size
  * @return    status code
  *            - 0 success
  *            - 1 draw string failed
@@ -210,9 +210,9 @@ uint8_t st7789_basic_string(uint16_t x, uint16_t y, char *str, uint16_t len, uin
 
 /**
  * @brief     basic example write a point
- * @param[in] x is the coordinate x
- * @param[in] y is the coordinate y
- * @param[in] color is the written color
+ * @param[in] x coordinate x
+ * @param[in] y coordinate y
+ * @param[in] color written color
  * @return    status code
  *            - 0 success
  *            - 1 write point failed
@@ -222,11 +222,11 @@ uint8_t st7789_basic_write_point(uint16_t x, uint16_t y, uint32_t color);
 
 /**
  * @brief     basic example fill a rectangle
- * @param[in] left is the left coordinate x
- * @param[in] top is the top coordinate y
- * @param[in] right is the right coordinate x
- * @param[in] bottom is the bottom coordinate y
- * @param[in] color is the display color
+ * @param[in] left left coordinate x
+ * @param[in] top top coordinate y
+ * @param[in] right right coordinate x
+ * @param[in] bottom bottom coordinate y
+ * @param[in] color display color
  * @return    status code
  *            - 0 success
  *            - 1 fill rect failed
@@ -236,11 +236,11 @@ uint8_t st7789_basic_rect(uint16_t left, uint16_t top, uint16_t right, uint16_t
 
 /**
  * @brief     basic example draw a 16 bits picture
- * @param[in] left is the left coordinate x
- * @param[in] top is the top coordinate y
- * @param[in] right is the right coordinate x
- * @param[in] bottom is the bottom coordinate y
- * @param[in] *img points to a image buffer
+ * @param[in] left left coordinate x
+ * @param[in] top top coordinate y
+ * @param[in] right right coordinate x
+ * @param[in] bottom bottom coordinate y
+ * @param[in] *img pointer to a image buffer
  * @return    status code
  *            - 0 success
  *            - 1 draw picture 16 bits failed

diff --git a/interface/driver_st7789_interface.h b/interface/driver_st7789_interface.h
@@ -70,8 +70,8 @@ uint8_t st7789_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
@@ -81,14 +81,14 @@ uint8_t st7789_interface_spi_write_cmd(uint8_t *buf, uint16_t len);
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void st7789_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 st7789_interface_debug_print(const char *const fmt, ...);
@@ -113,7 +113,7 @@ uint8_t st7789_interface_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
@@ -141,7 +141,7 @@ uint8_t st7789_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