Merge pull request #26 from libdriver/dev

docs: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.1.7 (2025-09-30)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.1.6 (2025-04-16)
 
 ## Bug Fixes

README.md

@@ -10,7 +10,7 @@
 
 AT24CXX is the EEPROM of IIC bus launched by Microchip. It supports 1.7v-5.5v power supply range, IIC standard mode (100kHz), fast mode (400kHz) and high speed mode (1MHz).
 
-LibDriver AT24CXX is a full-featured driver of AT24CXX launched by LibDriver. AT24CXX provides EEPROM write and read functions. LibDriver is MISRA compliant.
+LibDriver AT24CXX is a full-featured driver for AT24CXX, launched by LibDriver. It provides EEPROM writing, EEPROM reading and additional features. LibDriver is MISRA compliant.
 
 ### Table of Contents
 

doc/html/driver__at24cxx__basic_8c_source.html

@@ -152,7 +152,7 @@
 <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160; </div>
 <div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="group__at24cxx__example__driver.html#gaa02898549a780a296da7e25444a374f0">  129</a></span>&#160;uint8_t <a class="code" href="group__at24cxx__example__driver.html#gaa02898549a780a296da7e25444a374f0">at24cxx_basic_write</a>(uint32_t address, uint8_t *buf, uint16_t len)</div>
 <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;{</div>
-<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    <span class="comment">/* read data */</span></div>
+<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    <span class="comment">/* write data */</span></div>
 <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;    <span class="keywordflow">if</span> (<a class="code" href="group__at24cxx__base__driver.html#gacf3a0ca14713ff25125f3f655a38f681">at24cxx_write</a>(&amp;gs_handle, address, buf, len) != 0)</div>
 <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    {</div>
 <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;        <span class="keywordflow">return</span> 1;</div>

example/driver_at24cxx_basic.c

@@ -128,7 +128,7 @@ uint8_t at24cxx_basic_read(uint32_t address, uint8_t *buf, uint16_t len)
  */
 uint8_t at24cxx_basic_write(uint32_t address, uint8_t *buf, uint16_t len)
 {
-    /* read data */
+    /* write data */
     if (at24cxx_write(&gs_handle, address, buf, len) != 0)
     {
         return 1;

project/raspberrypi4b/driver/src/raspberrypi4b_driver_at24cxx_interface.c

@@ -155,14 +155,12 @@ void at24cxx_interface_delay_ms(uint32_t ms)
 void at24cxx_interface_debug_print(const char *const fmt, ...)
 {
     char str[256];
-    uint16_t len;
     va_list args;
 
     memset((char *)str, 0, sizeof(char) * 256); 
     va_start(args, fmt);
     vsnprintf((char *)str, 255, (char const *)fmt, args);
     va_end(args);
 
-    len = strlen((char *)str);
-    (void)printf((uint8_t *)str, len);
+    (void)printf((uint8_t *)str);
 }