Merge pull request #9 from libdriver/dev

fix: fix doc errors
libdriver · Nov 17, 2024 · cbb212f · cbb212f
2 parents ae6b8c7 + b4c35d5
commit cbb212f
Show file tree

Hide file tree

Showing 62 changed files with 388 additions and 381 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.4 (2024-11-17)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.3 (2024-08-15)
 
 ## Bug Fixes

diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ LibDriver LLCC68 is the full function driver of LLCC68 launched by LibDriver.It
   - [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_llcc68_lora.h"
@@ -181,8 +181,8 @@ if (res != 0)
 
 }
 
-/* set sent mode */
-res = llcc68_lora_set_sent_mode();
+/* set send mode */
+res = llcc68_lora_set_send_mode();
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -193,10 +193,10 @@ if (res != 0)
 
 }
 
-llcc68_interface_debug_print("llcc68: sent %s.\n", "123");
+llcc68_interface_debug_print("llcc68: send %s.\n", "123");
 
-/* sent data */
-res = llcc68_lora_sent((uint8_t *)"123", strlen("123"));
+/* send data */
+res = llcc68_lora_send((uint8_t *)"123", strlen("123"));
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -222,9 +222,10 @@ g_gpio_irq = NULL;
 
 return 0;
 ```
+
 #### example basic receive
 
-```c
+```C
 #include "driver_llcc68_lora.h"
 
 uint8_t (*g_gpio_irq)(void) = NULL;

diff --git a/README_de.md b/README_de.md
@@ -17,7 +17,7 @@ LibDriver LLCC68 ist der Treiber mit vollem Funktionsumfang von LLCC68, der von
   - [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_llcc68_lora.h"
@@ -181,8 +181,8 @@ if (res != 0)
 
 }
 
-/* set sent mode */
-res = llcc68_lora_set_sent_mode();
+/* set send mode */
+res = llcc68_lora_set_send_mode();
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -193,10 +193,10 @@ if (res != 0)
 
 }
 
-llcc68_interface_debug_print("llcc68: sent %s.\n", "123");
+llcc68_interface_debug_print("llcc68: send %s.\n", "123");
 
-/* sent data */
-res = llcc68_lora_sent((uint8_t *)"123", strlen("123"));
+/* send data */
+res = llcc68_lora_send((uint8_t *)"123", strlen("123"));
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -225,7 +225,7 @@ return 0;
 
 #### example basic receive
 
-```c
+```C
 #include "driver_llcc68_lora.h"
 
 uint8_t (*g_gpio_irq)(void) = NULL;

diff --git a/README_ja.md b/README_ja.md
@@ -17,7 +17,7 @@ LibDriver LLCC68 は、LibDriver が起動する LLCC68 のフル機能ドライ
   - [説明](#説明)
   - [インストール](#インストール)
   - [使用](#使用)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [ドキュメント](#ドキュメント)
   - [貢献](#貢献)
@@ -52,7 +52,7 @@ LibDriver LLCC68 は、LibDriver が起動する LLCC68 のフル機能ドライ
 
 /example ディレクトリ内のサンプルを参照して、独自のドライバーを完成させることができます。 デフォルトのプログラミング例を使用したい場合の使用方法は次のとおりです。
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_llcc68_lora.h"
@@ -181,8 +181,8 @@ if (res != 0)
 
 }
 
-/* set sent mode */
-res = llcc68_lora_set_sent_mode();
+/* set send mode */
+res = llcc68_lora_set_send_mode();
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -193,10 +193,10 @@ if (res != 0)
 
 }
 
-llcc68_interface_debug_print("llcc68: sent %s.\n", "123");
+llcc68_interface_debug_print("llcc68: send %s.\n", "123");
 
-/* sent data */
-res = llcc68_lora_sent((uint8_t *)"123", strlen("123"));
+/* send data */
+res = llcc68_lora_send((uint8_t *)"123", strlen("123"));
 if (res != 0)
 {
     (void)llcc68_lora_deinit();

diff --git a/README_ko.md b/README_ko.md
@@ -17,7 +17,7 @@ LibDriver LLCC68은 LibDriver에서 출시한 LLCC68의 전체 기능 드라이
   - [설명](#설명)
   - [설치](#설치)
   - [사용](#사용)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [문서](#문서)
   - [기고](#기고)
@@ -52,7 +52,7 @@ LibDriver LLCC68은 LibDriver에서 출시한 LLCC68의 전체 기능 드라이
 
 /example 디렉터리의 예제를 참조하여 자신만의 드라이버를 완성할 수 있습니다. 기본 프로그래밍 예제를 사용하려는 경우 사용 방법은 다음과 같습니다.
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_llcc68_lora.h"
@@ -181,8 +181,8 @@ if (res != 0)
 
 }
 
-/* set sent mode */
-res = llcc68_lora_set_sent_mode();
+/* set send mode */
+res = llcc68_lora_set_send_mode();
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -193,10 +193,10 @@ if (res != 0)
 
 }
 
-llcc68_interface_debug_print("llcc68: sent %s.\n", "123");
+llcc68_interface_debug_print("llcc68: send %s.\n", "123");
 
-/* sent data */
-res = llcc68_lora_sent((uint8_t *)"123", strlen("123"));
+/* send data */
+res = llcc68_lora_send((uint8_t *)"123", strlen("123"));
 if (res != 0)
 {
     (void)llcc68_lora_deinit();

diff --git a/README_zh-Hans.md b/README_zh-Hans.md
@@ -17,7 +17,7 @@ LibDriver LLCC68是LibDriver推出的LLCC68全功能驱动，提供无线发送
   - [说明](#说明)
   - [安装](#安装)
   - [使用](#使用)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [文档](#文档)
   - [贡献](#贡献)
@@ -52,7 +52,7 @@ LibDriver LLCC68是LibDriver推出的LLCC68全功能驱动，提供无线发送
 
 您可以参考/example目录下的编程范例完成适合您的驱动，如果您想要使用默认的编程范例，以下是它们的使用方法。
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_llcc68_lora.h"
@@ -181,8 +181,8 @@ if (res != 0)
 
 }
 
-/* set sent mode */
-res = llcc68_lora_set_sent_mode();
+/* set send mode */
+res = llcc68_lora_set_send_mode();
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -193,10 +193,10 @@ if (res != 0)
 
 }
 
-llcc68_interface_debug_print("llcc68: sent %s.\n", "123");
+llcc68_interface_debug_print("llcc68: send %s.\n", "123");
 
-/* sent data */
-res = llcc68_lora_sent((uint8_t *)"123", strlen("123"));
+/* send data */
+res = llcc68_lora_send((uint8_t *)"123", strlen("123"));
 if (res != 0)
 {
     (void)llcc68_lora_deinit();

diff --git a/README_zh-Hant.md b/README_zh-Hant.md
@@ -17,7 +17,7 @@ LibDriver LLCC68是LibDriver推出的LLCC68全功能驅動，提供無線發送
   - [說明](#說明)
   - [安裝](#安裝)
   - [使用](#使用)
-    - [example basic sent](#example-basic-sent)
+    - [example basic send](#example-basic-send)
     - [example basic receive](#example-basic-receive)
   - [文檔](#文檔)
   - [貢獻](#貢獻)
@@ -52,7 +52,7 @@ LibDriver LLCC68是LibDriver推出的LLCC68全功能驅動，提供無線發送
 
 您可以參考/example目錄下的程式設計範例完成適合您的驅動，如果您想要使用默認的程式設計範例，以下是它們的使用方法。
 
-#### example basic sent
+#### example basic send
 
 ```C
 #include "driver_llcc68_lora.h"
@@ -181,8 +181,8 @@ if (res != 0)
 
 }
 
-/* set sent mode */
-res = llcc68_lora_set_sent_mode();
+/* set send mode */
+res = llcc68_lora_set_send_mode();
 if (res != 0)
 {
     (void)llcc68_lora_deinit();
@@ -193,10 +193,10 @@ if (res != 0)
 
 }
 
-llcc68_interface_debug_print("llcc68: sent %s.\n", "123");
+llcc68_interface_debug_print("llcc68: send %s.\n", "123");
 
-/* sent data */
-res = llcc68_lora_sent((uint8_t *)"123", strlen("123"));
+/* send data */
+res = llcc68_lora_send((uint8_t *)"123", strlen("123"));
 if (res != 0)
 {
     (void)llcc68_lora_deinit();

diff --git a/doc/html/dir_13e138d54eb8818da29c3992edef070a.html b/doc/html/dir_13e138d54eb8818da29c3992edef070a.html
@@ -103,11 +103,11 @@
 <tr class="memitem:driver__llcc68__register__test_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__llcc68__register__test_8h.html">driver_llcc68_register_test.h</a> <a href="driver__llcc68__register__test_8h_source.html">[code]</a></td></tr>
 <tr class="memdesc:driver__llcc68__register__test_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver llcc68 register test header file <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:driver__llcc68__sent__receive__test_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__llcc68__sent__receive__test_8c.html">driver_llcc68_sent_receive_test.c</a> <a href="driver__llcc68__sent__receive__test_8c_source.html">[code]</a></td></tr>
-<tr class="memdesc:driver__llcc68__sent__receive__test_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver llcc68 sent receive test source file <br /></td></tr>
+<tr class="memitem:driver__llcc68__send__receive__test_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__llcc68__send__receive__test_8c.html">driver_llcc68_send_receive_test.c</a> <a href="driver__llcc68__send__receive__test_8c_source.html">[code]</a></td></tr>
+<tr class="memdesc:driver__llcc68__send__receive__test_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver llcc68 send receive test source file <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:driver__llcc68__sent__receive__test_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__llcc68__sent__receive__test_8h.html">driver_llcc68_sent_receive_test.h</a> <a href="driver__llcc68__sent__receive__test_8h_source.html">[code]</a></td></tr>
-<tr class="memdesc:driver__llcc68__sent__receive__test_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver llcc68 sent receive test header file <br /></td></tr>
+<tr class="memitem:driver__llcc68__send__receive__test_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__llcc68__send__receive__test_8h.html">driver_llcc68_send_receive_test.h</a> <a href="driver__llcc68__send__receive__test_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:driver__llcc68__send__receive__test_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">driver llcc68 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
@@ -4,6 +4,6 @@ var dir_13e138d54eb8818da29c3992edef070a =
     [ "driver_llcc68_cad_test.h", "driver__llcc68__cad__test_8h.html", "driver__llcc68__cad__test_8h" ],
     [ "driver_llcc68_register_test.c", "driver__llcc68__register__test_8c.html", "driver__llcc68__register__test_8c" ],
     [ "driver_llcc68_register_test.h", "driver__llcc68__register__test_8h.html", "driver__llcc68__register__test_8h" ],
-    [ "driver_llcc68_sent_receive_test.c", "driver__llcc68__sent__receive__test_8c.html", "driver__llcc68__sent__receive__test_8c" ],
-    [ "driver_llcc68_sent_receive_test.h", "driver__llcc68__sent__receive__test_8h.html", "driver__llcc68__sent__receive__test_8h" ]
+    [ "driver_llcc68_send_receive_test.c", "driver__llcc68__send__receive__test_8c.html", "driver__llcc68__send__receive__test_8c" ],
+    [ "driver_llcc68_send_receive_test.h", "driver__llcc68__send__receive__test_8h.html", "driver__llcc68__send__receive__test_8h" ]
 ];
diff --git a/doc/html/driver__llcc68_8c.html b/doc/html/driver__llcc68_8c.html
@@ -299,7 +299,7 @@
 <tr class="memdesc:ga187b4d302f145cf271e408d0ad17e295"><td class="mdescLeft">&#160;</td><td class="mdescRight">check the packet error  <a href="group__llcc68__command__driver.html#ga187b4d302f145cf271e408d0ad17e295">More...</a><br /></td></tr>
 <tr class="separator:ga187b4d302f145cf271e408d0ad17e295"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga1f95293c20361789dd389174dbce5e90"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__llcc68__command__driver.html#ga1f95293c20361789dd389174dbce5e90">llcc68_lora_transmit</a> (<a class="el" href="group__llcc68__command__driver.html#ga3cfd304d09728437424e8ada1e8a9375">llcc68_handle_t</a> *handle, <a class="el" href="group__llcc68__command__driver.html#ga136898138da9f75a412b145a874488ca">llcc68_clock_source_t</a> standby_src, uint16_t preamble_length, <a class="el" href="group__llcc68__command__driver.html#gacd40a98d06b932340e4da8af140f7c98">llcc68_lora_header_t</a> header_type, <a class="el" href="group__llcc68__command__driver.html#ga065933f1568152535754c9fc3635e885">llcc68_lora_crc_type_t</a> crc_type, <a class="el" href="group__llcc68__command__driver.html#ga099cd8e6e7515f7fdf5176eed69babdd">llcc68_bool_t</a> invert_iq_enable, uint8_t *buf, uint16_t len, uint32_t us)</td></tr>
-<tr class="memdesc:ga1f95293c20361789dd389174dbce5e90"><td class="mdescLeft">&#160;</td><td class="mdescRight">sent the lora data  <a href="group__llcc68__command__driver.html#ga1f95293c20361789dd389174dbce5e90">More...</a><br /></td></tr>
+<tr class="memdesc:ga1f95293c20361789dd389174dbce5e90"><td class="mdescLeft">&#160;</td><td class="mdescRight">send the lora data  <a href="group__llcc68__command__driver.html#ga1f95293c20361789dd389174dbce5e90">More...</a><br /></td></tr>
 <tr class="separator:ga1f95293c20361789dd389174dbce5e90"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga41b827744d2be4e7b7ad32a8db44ecff"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__llcc68__command__driver.html#ga41b827744d2be4e7b7ad32a8db44ecff">llcc68_write_register</a> (<a class="el" href="group__llcc68__command__driver.html#ga3cfd304d09728437424e8ada1e8a9375">llcc68_handle_t</a> *handle, uint16_t reg, uint8_t *buf, uint16_t len)</td></tr>
 <tr class="memdesc:ga41b827744d2be4e7b7ad32a8db44ecff"><td class="mdescLeft">&#160;</td><td class="mdescRight">write the register  <a href="group__llcc68__command__driver.html#ga41b827744d2be4e7b7ad32a8db44ecff">More...</a><br /></td></tr>