Merge pull request #15 from libdriver/dev

fix: fix doc errors
libdriver · Nov 17, 2024 · b977c30 · b977c30
2 parents 90b0183 + 3eba217
commit b977c30
Show file tree

Hide file tree

Showing 61 changed files with 394 additions and 386 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.2 (2024-11-17)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.1 (2024-08-10)
 
 ## Bug Fixes

diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ LibDriver NRF24L01 is the full function driver of NRF24L01 launched by LibDriver
   - [Instruction](#Instruction)
   - [Install](#Install)
   - [Usage](#Usage)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [Document](#Document)
   - [Contributing](#Contributing)
@@ -52,7 +52,7 @@ Add the /src directory, the interface driver for your platform, and your own dri
 
 You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_nrf24l01_basic.h"
@@ -82,7 +82,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
 
             break;
         }
@@ -119,7 +119,7 @@ if (res != 0)
 
     return 1;
 }
-if (nrf24l01_basic_sent((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
+if (nrf24l01_basic_send((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
 {
     (void)nrf24l01_basic_deinit();
     (void)gpio_interrupt_deinit();
@@ -140,9 +140,10 @@ g_gpio_irq = NULL;
 
 return 0;
 ```
+
 #### example basic receive
 
-```c
+```C
 #include "driver_nrf24l01_basic.h"
 
 uint8_t (*g_gpio_irq)(void) = NULL;
@@ -171,7 +172,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
             
             break;
         }

diff --git a/README_de.md b/README_de.md
@@ -17,7 +17,7 @@ LibDriver NRF24L01 ist der Treiber mit vollem Funktionsumfang von NRF24L01, der
   - [Anweisung](#Anweisung)
   - [Installieren](#Installieren)
   - [Nutzung](#Nutzung)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [Dokument](#Dokument)
   - [Beitrag](#Beitrag)
@@ -52,7 +52,7 @@ Fügen Sie das Verzeichnis /src, den Schnittstellentreiber für Ihre Plattform u
 
 Sie können auf die Beispiele im Verzeichnis /example zurückgreifen, um Ihren eigenen Treiber zu vervollständigen. Wenn Sie die Standardprogrammierbeispiele verwenden möchten, erfahren Sie hier, wie Sie diese verwenden.
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_nrf24l01_basic.h"
@@ -82,7 +82,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
 
             break;
         }
@@ -119,7 +119,7 @@ if (res != 0)
 
     return 1;
 }
-if (nrf24l01_basic_sent((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
+if (nrf24l01_basic_send((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
 {
     (void)nrf24l01_basic_deinit();
     (void)gpio_interrupt_deinit();
@@ -143,7 +143,7 @@ return 0;
 
 #### example basic receive
 
-```c
+```C
 #include "driver_nrf24l01_basic.h"
 
 uint8_t (*g_gpio_irq)(void) = NULL;
@@ -172,7 +172,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
             
             break;
         }

diff --git a/README_ja.md b/README_ja.md
@@ -17,7 +17,7 @@ LibDriver NRF24L01は、LibDriverによって起動されたNRF24L01の全機能
   - [説明](#説明)
   - [インストール](#インストール)
   - [使用](#使用)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [ドキュメント](#ドキュメント)
   - [貢献](#貢献)
@@ -52,7 +52,7 @@ LibDriver NRF24L01は、LibDriverによって起動されたNRF24L01の全機能
 
 /example ディレクトリ内のサンプルを参照して、独自のドライバーを完成させることができます。 デフォルトのプログラミング例を使用したい場合の使用方法は次のとおりです。
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_nrf24l01_basic.h"
@@ -82,7 +82,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
 
             break;
         }
@@ -119,7 +119,7 @@ if (res != 0)
 
     return 1;
 }
-if (nrf24l01_basic_sent((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
+if (nrf24l01_basic_send((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
 {
     (void)nrf24l01_basic_deinit();
     (void)gpio_interrupt_deinit();
@@ -172,7 +172,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
             
             break;
         }

diff --git a/README_ko.md b/README_ko.md
@@ -17,7 +17,7 @@ LibDriver NRF24L01은 LibDriver에서 출시한 NRF24L01의 전체 기능 드라
   - [설명](#설명)
   - [설치](#설치)
   - [사용](#사용)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [문서](#문서)
   - [기고](#기고)
@@ -52,7 +52,7 @@ LibDriver NRF24L01은 LibDriver에서 출시한 NRF24L01의 전체 기능 드라
 
 /example 디렉터리의 예제를 참조하여 자신만의 드라이버를 완성할 수 있습니다. 기본 프로그래밍 예제를 사용하려는 경우 사용 방법은 다음과 같습니다.
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_nrf24l01_basic.h"
@@ -82,7 +82,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
 
             break;
         }
@@ -119,7 +119,7 @@ if (res != 0)
 
     return 1;
 }
-if (nrf24l01_basic_sent((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
+if (nrf24l01_basic_send((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
 {
     (void)nrf24l01_basic_deinit();
     (void)gpio_interrupt_deinit();
@@ -172,7 +172,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
             
             break;
         }

diff --git a/README_zh-Hans.md b/README_zh-Hans.md
@@ -17,7 +17,7 @@ LibDriver NRF24L01是LibDriver推出的NRF24L01全功能驱动，提供无线发
   - [说明](#说明)
   - [安装](#安装)
   - [使用](#使用)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [文档](#文档)
   - [贡献](#贡献)
@@ -52,7 +52,7 @@ LibDriver NRF24L01是LibDriver推出的NRF24L01全功能驱动，提供无线发
 
 您可以参考/example目录下的编程范例完成适合您的驱动，如果您想要使用默认的编程范例，以下是它们的使用方法。
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_nrf24l01_basic.h"
@@ -82,7 +82,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
 
             break;
         }
@@ -119,7 +119,7 @@ if (res != 0)
 
     return 1;
 }
-if (nrf24l01_basic_sent((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
+if (nrf24l01_basic_send((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
 {
     (void)nrf24l01_basic_deinit();
     (void)gpio_interrupt_deinit();
@@ -172,7 +172,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
             
             break;
         }

diff --git a/README_zh-Hant.md b/README_zh-Hant.md
@@ -17,7 +17,7 @@ LibDriver NRF24L01是LibDriver推出的NRF24L01全功能驅動，提供無線發
   - [說明](#說明)
   - [安裝](#安裝)
   - [使用](#使用)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [文檔](#文檔)
   - [貢獻](#貢獻)
@@ -52,7 +52,7 @@ LibDriver NRF24L01是LibDriver推出的NRF24L01全功能驅動，提供無線發
 
 您可以參考/example目錄下的程式設計範例完成適合您的驅動，如果您想要使用默認的程式設計範例，以下是它們的使用方法。
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_nrf24l01_basic.h"
@@ -82,7 +82,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
 
             break;
         }
@@ -119,7 +119,7 @@ if (res != 0)
 
     return 1;
 }
-if (nrf24l01_basic_sent((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
+if (nrf24l01_basic_send((uint8_t *)addr, (uint8_t *)"123", 3) != 0);
 {
     (void)nrf24l01_basic_deinit();
     (void)gpio_interrupt_deinit();
@@ -172,7 +172,7 @@ static void a_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len)
         }
         case NRF24L01_INTERRUPT_TX_DS :
         {
-            nrf24l01_interface_debug_print("nrf24l01: irq sent ok.\n");
+            nrf24l01_interface_debug_print("nrf24l01: irq send ok.\n");
             
             break;
         }

diff --git a/doc/html/dir_13e138d54eb8818da29c3992edef070a.html b/doc/html/dir_13e138d54eb8818da29c3992edef070a.html
@@ -97,11 +97,11 @@
 <tr class="memitem:driver__nrf24l01__register__test_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__nrf24l01__register__test_8h.html">driver_nrf24l01_register_test.h</a> <a href="driver__nrf24l01__register__test_8h_source.html">[code]</a></td></tr>
 <tr class="memdesc:driver__nrf24l01__register__test_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver nrf24l01 register test header file <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:driver__nrf24l01__sent__receive__test_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__nrf24l01__sent__receive__test_8c.html">driver_nrf24l01_sent_receive_test.c</a> <a href="driver__nrf24l01__sent__receive__test_8c_source.html">[code]</a></td></tr>
-<tr class="memdesc:driver__nrf24l01__sent__receive__test_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver nrf24l01 sent receive test source file <br /></td></tr>
+<tr class="memitem:driver__nrf24l01__send__receive__test_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__nrf24l01__send__receive__test_8c.html">driver_nrf24l01_send_receive_test.c</a> <a href="driver__nrf24l01__send__receive__test_8c_source.html">[code]</a></td></tr>
+<tr class="memdesc:driver__nrf24l01__send__receive__test_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver nrf24l01 send receive test source file <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:driver__nrf24l01__sent__receive__test_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__nrf24l01__sent__receive__test_8h.html">driver_nrf24l01_sent_receive_test.h</a> <a href="driver__nrf24l01__sent__receive__test_8h_source.html">[code]</a></td></tr>
-<tr class="memdesc:driver__nrf24l01__sent__receive__test_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver nrf24l01 sent receive test header file <br /></td></tr>
+<tr class="memitem:driver__nrf24l01__send__receive__test_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__nrf24l01__send__receive__test_8h.html">driver_nrf24l01_send_receive_test.h</a> <a href="driver__nrf24l01__send__receive__test_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:driver__nrf24l01__send__receive__test_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver nrf24l01 send receive test header file <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 </div><!-- contents -->

diff --git a/doc/html/dir_13e138d54eb8818da29c3992edef070a.js b/doc/html/dir_13e138d54eb8818da29c3992edef070a.js
@@ -2,6 +2,6 @@ var dir_13e138d54eb8818da29c3992edef070a =
 [
     [ "driver_nrf24l01_register_test.c", "driver__nrf24l01__register__test_8c.html", "driver__nrf24l01__register__test_8c" ],
     [ "driver_nrf24l01_register_test.h", "driver__nrf24l01__register__test_8h.html", "driver__nrf24l01__register__test_8h" ],
-    [ "driver_nrf24l01_sent_receive_test.c", "driver__nrf24l01__sent__receive__test_8c.html", "driver__nrf24l01__sent__receive__test_8c" ],
-    [ "driver_nrf24l01_sent_receive_test.h", "driver__nrf24l01__sent__receive__test_8h.html", "driver__nrf24l01__sent__receive__test_8h" ]
+    [ "driver_nrf24l01_send_receive_test.c", "driver__nrf24l01__send__receive__test_8c.html", "driver__nrf24l01__send__receive__test_8c" ],
+    [ "driver_nrf24l01_send_receive_test.h", "driver__nrf24l01__send__receive__test_8h.html", "driver__nrf24l01__send__receive__test_8h" ]
 ];
diff --git a/doc/html/driver__nrf24l01_8c.html b/doc/html/driver__nrf24l01_8c.html
@@ -205,9 +205,9 @@
 <tr class="memitem:gab267d4890252f71ebe1f3c53de4869c2"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf24l01__basic__driver.html#gab267d4890252f71ebe1f3c53de4869c2">nrf24l01_set_active</a> (<a class="el" href="group__nrf24l01__basic__driver.html#ga14622225dc15b2e77111c2ffd7fe6aa2">nrf24l01_handle_t</a> *handle, <a class="el" href="group__nrf24l01__basic__driver.html#gaf7c2c9c79ad318ac9227392c46c3d4cb">nrf24l01_bool_t</a> enable)</td></tr>
 <tr class="memdesc:gab267d4890252f71ebe1f3c53de4869c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">enable or disable the chip  <a href="group__nrf24l01__basic__driver.html#gab267d4890252f71ebe1f3c53de4869c2">More...</a><br /></td></tr>
 <tr class="separator:gab267d4890252f71ebe1f3c53de4869c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga22cc44dbeaa686a48067432ae160d202"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf24l01__basic__driver.html#ga22cc44dbeaa686a48067432ae160d202">nrf24l01_sent</a> (<a class="el" href="group__nrf24l01__basic__driver.html#ga14622225dc15b2e77111c2ffd7fe6aa2">nrf24l01_handle_t</a> *handle, uint8_t *buf, uint8_t len)</td></tr>
-<tr class="memdesc:ga22cc44dbeaa686a48067432ae160d202"><td class="mdescLeft">&#160;</td><td class="mdescRight">sent data  <a href="group__nrf24l01__basic__driver.html#ga22cc44dbeaa686a48067432ae160d202">More...</a><br /></td></tr>
-<tr class="separator:ga22cc44dbeaa686a48067432ae160d202"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga4d16ffba1278d7350757277cffbbbdd0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf24l01__basic__driver.html#ga4d16ffba1278d7350757277cffbbbdd0">nrf24l01_send</a> (<a class="el" href="group__nrf24l01__basic__driver.html#ga14622225dc15b2e77111c2ffd7fe6aa2">nrf24l01_handle_t</a> *handle, uint8_t *buf, uint8_t len)</td></tr>
+<tr class="memdesc:ga4d16ffba1278d7350757277cffbbbdd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">send data  <a href="group__nrf24l01__basic__driver.html#ga4d16ffba1278d7350757277cffbbbdd0">More...</a><br /></td></tr>
+<tr class="separator:ga4d16ffba1278d7350757277cffbbbdd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga7f02d365e80ea7d3b67cd13695649f55"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf24l01__basic__driver.html#ga7f02d365e80ea7d3b67cd13695649f55">nrf24l01_irq_handler</a> (<a class="el" href="group__nrf24l01__basic__driver.html#ga14622225dc15b2e77111c2ffd7fe6aa2">nrf24l01_handle_t</a> *handle)</td></tr>
 <tr class="memdesc:ga7f02d365e80ea7d3b67cd13695649f55"><td class="mdescLeft">&#160;</td><td class="mdescRight">irq handler  <a href="group__nrf24l01__basic__driver.html#ga7f02d365e80ea7d3b67cd13695649f55">More...</a><br /></td></tr>
 <tr class="separator:ga7f02d365e80ea7d3b67cd13695649f55"><td class="memSeparator" colspan="2">&#160;</td></tr>

diff --git a/doc/html/driver__nrf24l01_8c.js b/doc/html/driver__nrf24l01_8c.js
@@ -94,7 +94,7 @@ var driver__nrf24l01_8c =
     [ "nrf24l01_nop", "group__nrf24l01__basic__driver.html#ga3520243e920e4dbf8846cf5016255b6f", null ],
     [ "nrf24l01_read_rx_payload", "group__nrf24l01__basic__driver.html#gaa3841453ced28cbb4cdef1a6144e32f7", null ],
     [ "nrf24l01_reuse_tx_payload", "group__nrf24l01__basic__driver.html#gafa55163d50332c4e5cd134a670ae2ea7", null ],
-    [ "nrf24l01_sent", "group__nrf24l01__basic__driver.html#ga22cc44dbeaa686a48067432ae160d202", null ],
+    [ "nrf24l01_send", "group__nrf24l01__basic__driver.html#ga4d16ffba1278d7350757277cffbbbdd0", null ],
     [ "nrf24l01_set_active", "group__nrf24l01__basic__driver.html#gab267d4890252f71ebe1f3c53de4869c2", null ],
     [ "nrf24l01_set_address_width", "group__nrf24l01__basic__driver.html#gaaaf2630fff7c441851f6abf6c6d2d06f", null ],
     [ "nrf24l01_set_auto_acknowledgment", "group__nrf24l01__basic__driver.html#ga828178ab257acd0b00ddacf804785ce3", null ],