fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.5 (2024-12-28)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.4 (2024-11-27)
 
 ## Bug Fixes

doc/html/group__ssd1306__base__driver.html

@@ -1288,8 +1288,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafddd477453ae1738a64e40f
 <p>advance example set the fade blinking mode </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the fade blinking mode </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">frames</td><td>is the fade or blinking frames </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>fade blinking mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">frames</td><td>fade or blinking frames </td></tr>
   </table>
   </dd>
 </dl>
@@ -1333,8 +1333,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga00f7376bc972dfa46937f64
 <p>advance example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the interface type </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>interface type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -1396,11 +1396,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga63d6051817db7dafb29308b
 <p>advance example draw a picture </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>is the left coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>is the top coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>is the right coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>is the bottom coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*img</td><td>points to a image buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>left coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>top coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>right coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>bottom coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*img</td><td>pointer to a image buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1450,9 +1450,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga48023692dea95d41612e4e4
 <p>advance example read a point </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>is the coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>is the coordinate y </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>points to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>coordinate y </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>pointer to a data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1514,11 +1514,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab2251ba239b4ce65398e219
 <p>advance example fill a rectangle </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>is the left coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>is the top coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>is the right coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>is the bottom coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>is the display color </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>left coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>top coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>right coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>bottom coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>display color </td></tr>
   </table>
   </dd>
 </dl>
@@ -1586,12 +1586,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafb02aebf237c1e24f50252a
 <p>advance example draw a string </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>is the coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>is the coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*str</td><td>points to a written string address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the length of the string </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>is the display color </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">font</td><td>is the display font size </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*str</td><td>pointer to a written string address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of the string </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>display color </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">font</td><td>display font size </td></tr>
   </table>
   </dd>
 </dl>
@@ -1647,10 +1647,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1c47572695cfc539ebe9f9f
 <p>advance example enable the left horizontal scroll </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">start_page_addr</td><td>is the start page address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">end_page_addr</td><td>is the end page address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">rows</td><td>is the row address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">frames</td><td>is the scroll frames </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">start_page_addr</td><td>start page address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">end_page_addr</td><td>end page address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">rows</td><td>row address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">frames</td><td>scroll frames </td></tr>
   </table>
   </dd>
 </dl>
@@ -1706,10 +1706,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga407b64acda9174b5f30a808
 <p>advance example enable the right horizontal scroll </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">start_page_addr</td><td>is the start page address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">end_page_addr</td><td>is the end page address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">rows</td><td>is the row address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">frames</td><td>is the scroll frames </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">start_page_addr</td><td>start page address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">end_page_addr</td><td>end page address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">rows</td><td>row address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">frames</td><td>scroll frames </td></tr>
   </table>
   </dd>
 </dl>
@@ -1759,9 +1759,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf6a13365d4c88a2c0c73618
 <p>advance example write a point </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>is the coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>is the coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>is the written data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>written data </td></tr>
   </table>
   </dd>
 </dl>
@@ -1917,8 +1917,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac6df70c9cd57ef76ea4a615
 <p>basic example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the interface type </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>interface type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -1980,11 +1980,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabf4b49fe9e052b883d8adff
 <p>basic example draw a picture </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>is the left coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>is the top coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>is the right coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>is the bottom coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*img</td><td>points to a image buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>left coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>top coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>right coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>bottom coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*img</td><td>pointer to a image buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -2034,9 +2034,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae5fa989bb84f5da6ab4052c
 <p>basic example read a point </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>is the coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>is the coordinate y </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>points to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>coordinate y </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>pointer to a data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -2098,11 +2098,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabac763a98b6b51f000c66a2
 <p>basic example fill a rectangle </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>is the left coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>is the top coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>is the right coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>is the bottom coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>is the display color </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>left coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>top coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>right coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>bottom coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>display color </td></tr>
   </table>
   </dd>
 </dl>
@@ -2170,12 +2170,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab0de9699713b18ef742c7df
 <p>basic example draw a string </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>is the coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>is the coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*str</td><td>points to a written string address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the length of the string </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>is the display color </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">font</td><td>is the display font size </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*str</td><td>pointer to a written string address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of the string </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">color</td><td>display color </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">font</td><td>display font size </td></tr>
   </table>
   </dd>
 </dl>
@@ -2225,9 +2225,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf6b46f994d377464ac2a3df
 <p>basic example write a point </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>is the coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>is the coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>is the written data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>written data </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ssd1306__example__driver.html

@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae7e83bf4fa2b4edefda280b
 <p>write the register 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 ssd1306 handle structure </td></tr>
-    <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 data length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ssd1306 handle structure </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>data length </td></tr>
   </table>
   </dd>
 </dl>
@@ -195,9 +195,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9cca12cd680a5956ba27f6b
 <p>write the register 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 ssd1306 handle structure </td></tr>
-    <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 data length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ssd1306 handle structure </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>data length </td></tr>
   </table>
   </dd>
 </dl>