Skip to content

Commit 02acb91

Browse files
committed
docs: fix doc errors
1 parent 199712b commit 02acb91

File tree

5 files changed

+10
-6
lines changed

5 files changed

+10
-6
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 2.1.7 (2025-09-30)
2+
3+
## Bug Fixes
4+
5+
- fix doc errors
6+
17
## 2.1.6 (2025-04-16)
28

39
## Bug Fixes

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
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).
1212

13-
LibDriver AT24CXX is a full-featured driver of AT24CXX launched by LibDriver. AT24CXX provides EEPROM write and read functions. LibDriver is MISRA compliant.
13+
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.
1414

1515
### Table of Contents
1616

doc/html/driver__at24cxx__basic_8c_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@
152152
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div>
153153
<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>
154154
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;{</div>
155-
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="comment">/* read data */</span></div>
155+
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="comment">/* write data */</span></div>
156156
<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>
157157
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; {</div>
158158
<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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ uint8_t at24cxx_basic_read(uint32_t address, uint8_t *buf, uint16_t len)
128128
*/
129129
uint8_t at24cxx_basic_write(uint32_t address, uint8_t *buf, uint16_t len)
130130
{
131-
/* read data */
131+
/* write data */
132132
if (at24cxx_write(&gs_handle, address, buf, len) != 0)
133133
{
134134
return 1;

project/raspberrypi4b/driver/src/raspberrypi4b_driver_at24cxx_interface.c

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,14 +155,12 @@ void at24cxx_interface_delay_ms(uint32_t ms)
155155
void at24cxx_interface_debug_print(const char *const fmt, ...)
156156
{
157157
char str[256];
158-
uint16_t len;
159158
va_list args;
160159

161160
memset((char *)str, 0, sizeof(char) * 256);
162161
va_start(args, fmt);
163162
vsnprintf((char *)str, 255, (char const *)fmt, args);
164163
va_end(args);
165164

166-
len = strlen((char *)str);
167-
(void)printf((uint8_t *)str, len);
165+
(void)printf((uint8_t *)str);
168166
}

0 commit comments

Comments
 (0)