Merge pull request #2 from hepingood/dev

libdriver · web-flow · commit c278c37d4fa2 · 2022-04-16T14:54:44.000+08:00
docs: change the README
diff --git a/README.md b/README.md
@@ -54,17 +54,17 @@ uint8_t res;
 uint8_t data;
 
 res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
-if (res)
+if (res != 0)
 {
     return 1;
 }
 
 ...
 
 res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -76,9 +76,9 @@ else
 ...
 
 res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -89,7 +89,7 @@ else
 
 ...
 
-at24cxx_basic_deinit();
+(void)at24cxx_basic_deinit();
 
 return 0;
 ```
diff --git a/README_de.md b/README_de.md
@@ -53,17 +53,17 @@ uint8_t res;
 uint8_t data;
 
 res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
-if (res)
+if (res != 0)
 {
     return 1;
 }
 
 ...
 
 res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -75,9 +75,9 @@ else
 ...
 
 res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -88,7 +88,7 @@ else
 
 ...
 
-at24cxx_basic_deinit();
+(void)at24cxx_basic_deinit();
 
 return 0;
 ```
diff --git a/README_ja.md b/README_ja.md
@@ -54,17 +54,17 @@ uint8_t res;
 uint8_t data;
 
 res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
-if (res)
+if (res != 0)
 {
     return 1;
 }
 
 ...
 
 res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -76,9 +76,9 @@ else
 ...
 
 res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -89,7 +89,7 @@ else
 
 ...
 
-at24cxx_basic_deinit();
+(void)at24cxx_basic_deinit();
 
 return 0;
 ```
diff --git a/README_ko.md b/README_ko.md
@@ -54,17 +54,17 @@ uint8_t res;
 uint8_t data;
 
 res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
-if (res)
+if (res != 0)
 {
     return 1;
 }
 
 ...
 
 res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -76,9 +76,9 @@ else
 ...
 
 res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -89,7 +89,7 @@ else
 
 ...
 
-at24cxx_basic_deinit();
+(void)at24cxx_basic_deinit();
 
 return 0;
 ```
diff --git a/README_zh-Hans.md b/README_zh-Hans.md
@@ -54,17 +54,17 @@ uint8_t res;
 uint8_t data;
 
 res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
-if (res)
+if (res != 0)
 {
     return 1;
 }
 
 ...
 
 res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -76,9 +76,9 @@ else
 ...
 
 res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -89,7 +89,7 @@ else
 
 ...
 
-at24cxx_basic_deinit();
+(void)at24cxx_basic_deinit();
 
 return 0;
 ```
diff --git a/README_zh-Hant.md b/README_zh-Hant.md
@@ -54,17 +54,17 @@ uint8_t res;
 uint8_t data;
 
 res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);
-if (res)
+if (res != 0)
 {
     return 1;
 }
 
 ...
 
 res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -76,9 +76,9 @@ else
 ...
 
 res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);
-if (res)
+if (res != 0)
 {
-    at24cxx_basic_deinit();
+    (void)at24cxx_basic_deinit();
 
     return 1;
 }
@@ -89,7 +89,7 @@ else
 
 ...
 
-at24cxx_basic_deinit();
+(void)at24cxx_basic_deinit();
 
 return 0;
 ```

Original file line number	Diff line number	Diff line change
`@@ -54,17 +54,17 @@ uint8_t res;`
`54`	`54`	`uint8_t data;`
`55`	`55`
`56`	`56`	`res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);`
`57`		`-if (res)`
	`57`	`+if (res != 0)`
`58`	`58`	`{`
`59`	`59`	`return 1;`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`...`
`63`	`63`
`64`	`64`	`res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);`
`65`		`-if (res)`
	`65`	`+if (res != 0)`
`66`	`66`	`{`
`67`		`- at24cxx_basic_deinit();`
	`67`	`+ (void)at24cxx_basic_deinit();`
`68`	`68`
`69`	`69`	`return 1;`
`70`	`70`	`}`
`@@ -76,9 +76,9 @@ else`
`76`	`76`	`...`
`77`	`77`
`78`	`78`	`res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);`
`79`		`-if (res)`
	`79`	`+if (res != 0)`
`80`	`80`	`{`
`81`		`- at24cxx_basic_deinit();`
	`81`	`+ (void)at24cxx_basic_deinit();`
`82`	`82`
`83`	`83`	`return 1;`
`84`	`84`	`}`
`@@ -89,7 +89,7 @@ else`
`89`	`89`
`90`	`90`	`...`
`91`	`91`
`92`		`-at24cxx_basic_deinit();`
	`92`	`+(void)at24cxx_basic_deinit();`
`93`	`93`
`94`	`94`	`return 0;`
`95`	`95`	```
Original file line number	Diff line number	Diff line change
`@@ -53,17 +53,17 @@ uint8_t res;`
`53`	`53`	`uint8_t data;`
`54`	`54`
`55`	`55`	`res = at24cxx_basic_init(AT24C01, AT24CXX_ADDRESS_A000);`
`56`		`-if (res)`
	`56`	`+if (res != 0)`
`57`	`57`	`{`
`58`	`58`	`return 1;`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`...`
`62`	`62`
`63`	`63`	`res = at24cxx_basic_read(0x00, (uint8_t *)&data, 1);`
`64`		`-if (res)`
	`64`	`+if (res != 0)`
`65`	`65`	`{`
`66`		`- at24cxx_basic_deinit();`
	`66`	`+ (void)at24cxx_basic_deinit();`
`67`	`67`
`68`	`68`	`return 1;`
`69`	`69`	`}`
`@@ -75,9 +75,9 @@ else`
`75`	`75`	`...`
`76`	`76`
`77`	`77`	`res = at24cxx_basic_write(0x00, (uint8_t *)&data, 1);`
`78`		`-if (res)`
	`78`	`+if (res != 0)`
`79`	`79`	`{`
`80`		`- at24cxx_basic_deinit();`
	`80`	`+ (void)at24cxx_basic_deinit();`
`81`	`81`
`82`	`82`	`return 1;`
`83`	`83`	`}`
`@@ -88,7 +88,7 @@ else`
`88`	`88`
`89`	`89`	`...`
`90`	`90`
`91`		`-at24cxx_basic_deinit();`
	`91`	`+(void)at24cxx_basic_deinit();`
`92`	`92`
`93`	`93`	`return 0;`
`94`	`94`	```