Merge pull request #33 from libdriver/dev

libdriver · web-flow · commit a01e33f4bcf3 · 2025-04-19T14:34:13.000+08:00
fix: fix doc errors
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.8 (2025-04-16)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.7 (2025-03-31)
 
 ## Bug Fixes
diff --git a/Doxyfile b/Doxyfile
@@ -44,7 +44,7 @@ PROJECT_NUMBER         = 1.0.0
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "W25QXX full function driver"
+PROJECT_BRIEF          = "W25QXX full-featured driver"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 The W25Q25XX Serial Flash memory provides a storage solution for systems with limited space, pins and power. The 25Q series offers flexibility and performance well beyond ordinary Serial Flash devices. They are ideal for code shadowing to RAM, executing code directly from Dual/Quad SPI (XIP) and storing voice, text and data. The device operates on a single 2.7V to 3.6V power supply with current consumption as low as 4mA active and 1μA for power-down. All devices are offered in space-saving packages.
 
-LibDriver W25QXX is the full function driver of W25QXX launched by LibDriver.It provides functions of flash reading,flash writing, etc. LibDriver is MISRA compliant.
+LibDriver W25QXX is a full-featured driver of W25QXX launched by LibDriver.It provides functions of flash reading,flash writing, etc. LibDriver is MISRA compliant.
 
 ### Table of Contents
 
diff --git a/doc/html/annotated.html b/doc/html/annotated.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/classes.html b/doc/html/classes.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/dir_11ec664f88f5f079ad4de1adb8458c37.html b/doc/html/dir_11ec664f88f5f079ad4de1adb8458c37.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/dir_13e138d54eb8818da29c3992edef070a.html b/doc/html/dir_13e138d54eb8818da29c3992edef070a.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/dir_b31d54d5631803016a26f28213a41162.html b/doc/html/dir_b31d54d5631803016a26f28213a41162.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html b/doc/html/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/dir_e68e8157741866f444e17edd764ebbae.html b/doc/html/dir_e68e8157741866f444e17edd764ebbae.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx_8c.html b/doc/html/driver__w25qxx_8c.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx_8c_source.html b/doc/html/driver__w25qxx_8c_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx_8h.html b/doc/html/driver__w25qxx_8h.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx_8h_source.html b/doc/html/driver__w25qxx_8h_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__advance_8c.html b/doc/html/driver__w25qxx__advance_8c.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__advance_8c_source.html b/doc/html/driver__w25qxx__advance_8c_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__advance_8h.html b/doc/html/driver__w25qxx__advance_8h.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__advance_8h_source.html b/doc/html/driver__w25qxx__advance_8h_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__basic_8c.html b/doc/html/driver__w25qxx__basic_8c.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__basic_8c_source.html b/doc/html/driver__w25qxx__basic_8c_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__basic_8h.html b/doc/html/driver__w25qxx__basic_8h.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__basic_8h_source.html b/doc/html/driver__w25qxx__basic_8h_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__interface_8h.html b/doc/html/driver__w25qxx__interface_8h.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__interface_8h_source.html b/doc/html/driver__w25qxx__interface_8h_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__interface__template_8c.html b/doc/html/driver__w25qxx__interface__template_8c.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__interface__template_8c_source.html b/doc/html/driver__w25qxx__interface__template_8c_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__read__test_8c.html b/doc/html/driver__w25qxx__read__test_8c.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__read__test_8c_source.html b/doc/html/driver__w25qxx__read__test_8c_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__read__test_8h.html b/doc/html/driver__w25qxx__read__test_8h.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__read__test_8h_source.html b/doc/html/driver__w25qxx__read__test_8h_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__register__test_8c.html b/doc/html/driver__w25qxx__register__test_8c.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__register__test_8c_source.html b/doc/html/driver__w25qxx__register__test_8c_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__register__test_8h.html b/doc/html/driver__w25qxx__register__test_8h.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/driver__w25qxx__register__test_8h_source.html b/doc/html/driver__w25qxx__register__test_8h_source.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/files.html b/doc/html/files.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/functions.html b/doc/html/functions.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/functions_vars.html b/doc/html/functions_vars.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/globals.html b/doc/html/globals.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/globals_d.html b/doc/html/globals_d.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/globals_defs.html b/doc/html/globals_defs.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/globals_enum.html b/doc/html/globals_enum.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/globals_eval.html b/doc/html/globals_eval.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/globals_func.html b/doc/html/globals_func.html
@@ -29,7 +29,7 @@
    <div id="projectname">LibDriver W25QXX
    &#160;<span id="projectnumber">1.0.0</span>
    </div>
-   <div id="projectbrief">W25QXX full function driver</div>
+   <div id="projectbrief">W25QXX full-featured driver</div>
   </td>
  </tr>
  </tbody>
diff --git a/doc/html/globals_m.html b/doc/html/globals_m.html
diff --git a/doc/html/globals_s.html b/doc/html/globals_s.html
diff --git a/doc/html/globals_t.html b/doc/html/globals_t.html
diff --git a/doc/html/globals_type.html b/doc/html/globals_type.html
diff --git a/doc/html/globals_w.html b/doc/html/globals_w.html
diff --git a/doc/html/group__w25qxx__advance__driver.html b/doc/html/group__w25qxx__advance__driver.html
diff --git a/doc/html/group__w25qxx__basic__driver.html b/doc/html/group__w25qxx__basic__driver.html
diff --git a/doc/html/group__w25qxx__driver.html b/doc/html/group__w25qxx__driver.html
diff --git a/doc/html/group__w25qxx__example__driver.html b/doc/html/group__w25qxx__example__driver.html
diff --git a/doc/html/group__w25qxx__extern__driver.html b/doc/html/group__w25qxx__extern__driver.html
diff --git a/doc/html/group__w25qxx__interface__driver.html b/doc/html/group__w25qxx__interface__driver.html
diff --git a/doc/html/group__w25qxx__link__driver.html b/doc/html/group__w25qxx__link__driver.html
diff --git a/doc/html/group__w25qxx__test__driver.html b/doc/html/group__w25qxx__test__driver.html
diff --git a/doc/html/index.html b/doc/html/index.html
diff --git a/doc/html/mainpage_8h.html b/doc/html/mainpage_8h.html
diff --git a/doc/html/mainpage_8h_source.html b/doc/html/mainpage_8h_source.html
diff --git a/doc/html/modules.html b/doc/html/modules.html
diff --git a/doc/html/structw25qxx__handle__s.html b/doc/html/structw25qxx__handle__s.html
diff --git a/doc/html/structw25qxx__info__s.html b/doc/html/structw25qxx__info__s.html
diff --git a/doc/mainpage/mainpage.h b/doc/mainpage/mainpage.h
