Merge pull request #14 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.3 (2024-12-07)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.2 (2024-10-02)
 
 ## Bug Fixes

doc/html/group__ds3231__advance__driver.html

@@ -168,9 +168,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac43a1fd4f23e44e827b20d2
 <p>convert a register raw data to a converted aging offset 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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the register raw data </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*offset</td><td>points to a converted aging offset buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>register raw data </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*offset</td><td>pointer to a converted aging offset buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -221,9 +221,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacf71c847b348df46bd1fcd2
 <p>convert a aging offset value to a register raw 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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>is a converted aging offset value </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>points to a register raw buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>converted aging offset value </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>pointer to a register raw buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -268,8 +268,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga11050892209e042d93cff29
 <p>get the 32KHz output status </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a bool value buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>pointer to a bool value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -315,8 +315,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac49560e6150451592c9a1b3
 <p>get the chip aging offset </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*offset</td><td>points to a time aging offset buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*offset</td><td>pointer to a time aging offset buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -362,8 +362,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2ea4af3ba7b027fde39615a
 <p>get the chip pin 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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pin</td><td>points to a pin's function buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*pin</td><td>pointer to a pin's function buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -409,8 +409,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaeb578fdee1552c45d01f516
 <p>get the square wave output status </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a bool value buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>pointer to a bool value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -462,9 +462,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4ab9b57ec4e72e9898aad7e
 <p>get the chip temperature </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*s</td><td>points to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*s</td><td>pointer to a converted temperature buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -510,8 +510,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad06f018ac2a097830ccf6b6
 <p>enable or disable the 32KHz output </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -557,8 +557,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga49a0b05ec4e492162dc9cf5
 <p>set the chip aging offset </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>is time aging offset </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>time aging offset </td></tr>
   </table>
   </dd>
 </dl>
@@ -604,8 +604,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9b19cc6345dc16d4f988518
 <p>set the chip pin 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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>is the pin's function </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>pin function </td></tr>
   </table>
   </dd>
 </dl>
@@ -651,8 +651,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadeaab17893161895a8ee84f
 <p>enable or disable the square wave output </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ds3231__alarm__driver.html

@@ -240,8 +240,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga778045abae85c26cc9b0fa4
 <p>clear the alarm flag </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>is the alarm number </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>alarm number </td></tr>
   </table>
   </dd>
 </dl>
@@ -293,9 +293,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4cba773db2d900e023dce8a
 <p>get the alarm1 time </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>points to a time structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>points to an alarm1 interrupt mode buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>pointer to a time structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>pointer to an alarm1 interrupt mode buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -347,9 +347,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga907fa44e0f9b5ede2633ceb
 <p>get the alarm2 time </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>points to a time structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>points to an alarm2 interrupt mode buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>pointer to a time structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>pointer to an alarm2 interrupt mode buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -401,9 +401,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga266fe010eb4fdd4c0aadf21
 <p>get the alarm interrupt status </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>is the alarm number </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a bool value buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>alarm number </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>pointer to a bool value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -455,9 +455,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7d17165899cecab98420457
 <p>set the alarm1 time </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>points to a time structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the alarm1 interrupt mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>pointer to a time structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>alarm1 interrupt mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -509,9 +509,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga613e9afc81d5f8eaba82178
 <p>set the alarm2 time </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>points to a time structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the alarm2 interrupt mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>pointer to a time structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>alarm2 interrupt mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -563,9 +563,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga30ef06098c0b1854aa792a2
 <p>enable or disable the alarm interrupt </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>is the alarm number </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>alarm number </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ds3231__base__driver.html

@@ -400,7 +400,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadd1988301d419380a0d6bdf
 <p>close the chip </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 a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -446,8 +446,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0e7218d30b2a689890f8921
 <p>get the chip oscillator status </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a bool value buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>pointer to a bool value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -493,8 +493,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaea7c133c8e759c94b8d0e29
 <p>get the chip status </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>points to a chip status buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>pointer to a chip status buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -540,8 +540,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabe9d692b88f8d5710ead006
 <p>get the current time </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>points to a time structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>pointer to a time structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -577,7 +577,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga345a8eeaa00e23e1387408d
 <p>get chip's information </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>points to a ds3231 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a ds3231 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -611,7 +611,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaba87dc05cadec0df3dc0b9
 <p>initialize the chip </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 a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -647,7 +647,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga428a39a0a96085e8481cbb5
 <p>irq handler </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 a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -693,8 +693,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga019899f8bed7d2c8afd6f08
 <p>enable or disable the oscillator </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -740,8 +740,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga05b741038c591595714004c
 <p>set the current time </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 a ds3231 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>points to a time structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ds3231 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>pointer to a time structure </td></tr>
   </table>
   </dd>
 </dl>