Added more comments to pinMode definition

blemasle · blemasle · commit 39737a7c97d1 · 2020-04-13T23:26:15.000+02:00
diff --git a/src/MCP23017.h b/src/MCP23017.h
@@ -95,7 +95,10 @@ class MCP23017
 	 *
 	 * See "3.5.1 I/O Direction register".
 	 * 
-	 * Beware! Mode here behave as the standard arduino pinMode :
+	 * Beware!  
+	 * On Arduino platform, INPUT = 0, OUTPUT = 1, which is the inverse
+	 * of the MCP23017 definition where a pin is an input if its IODIR bit is set to 1.
+	 * This library pinMode function behaves like Arduino's standard pinMode for consistency.
 	 * [ OUTPUT | INPUT | INPUT_PULLUP ]
 	 */
 	void pinMode(uint8_t pin, uint8_t mode, bool inverted = false);

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,10 @@ class MCP23017`
`95`	`95`	`*`
`96`	`96`	`* See "3.5.1 I/O Direction register".`
`97`	`97`	`*`
`98`		`- * Beware! Mode here behave as the standard arduino pinMode :`
	`98`	`+ * Beware!`
	`99`	`+ * On Arduino platform, INPUT = 0, OUTPUT = 1, which is the inverse`
	`100`	`+ * of the MCP23017 definition where a pin is an input if its IODIR bit is set to 1.`
	`101`	`+ * This library pinMode function behaves like Arduino's standard pinMode for consistency.`
`99`	`102`	`* [ OUTPUT \| INPUT \| INPUT_PULLUP ]`
`100`	`103`	`*/`
`101`	`104`	`void pinMode(uint8_t pin, uint8_t mode, bool inverted = false);`