Correct erroneous comment re: Servo::attach return

per1234 · web-flow · commit 12d0baa24dfa · 2021-12-04T21:49:32.000-08:00
The comment claimed that 0 was returned by `Servo::attach` on failure. This is incorrect. The return value is the channel number, which is 0 for the `Servo` object that is instantiated first.

Instead, `INVALID_SERVO` (defined as 255) is returned on failure.
diff --git a/src/Servo.h b/src/Servo.h
@@ -105,7 +105,7 @@ class Servo
 {
 public:
   Servo();
-  uint8_t attach(int pin);           // attach the given pin to the next free channel, sets pinMode, returns channel number or 0 if failure
+  uint8_t attach(int pin);           // attach the given pin to the next free channel, sets pinMode, returns channel number or INVALID_SERVO if failure
   uint8_t attach(int pin, int min, int max); // as above but also sets min and max values for writes. 
   void detach();
   void write(int value);             // if value is < 200 its treated as an angle, otherwise as pulse width in microseconds 

Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ class Servo`
`105`	`105`	`{`
`106`	`106`	`public:`
`107`	`107`	`Servo();`
`108`		`- uint8_t attach(int pin); // attach the given pin to the next free channel, sets pinMode, returns channel number or 0 if failure`
	`108`	`+ uint8_t attach(int pin); // attach the given pin to the next free channel, sets pinMode, returns channel number or INVALID_SERVO if failure`
`109`	`109`	`uint8_t attach(int pin, int min, int max); // as above but also sets min and max values for writes.`
`110`	`110`	`void detach();`
`111`	`111`	`void write(int value); // if value is < 200 its treated as an angle, otherwise as pulse width in microseconds`