Fix documentation's example

platisd · platisd · commit 1e3c6002783e · 2025-01-06T15:33:49.000+02:00
diff --git a/src/car/heading/HeadingCar.hpp b/src/car/heading/HeadingCar.hpp
@@ -17,13 +17,14 @@ class HeadingCar : virtual public SimpleCar
      *
      * **Example:**
      * \code
-     * const int GYROSCOPE_OFFSET = 37;
      *
      * BrushedMotor leftMotor(smartcarlib::pins::v2::leftMotorPins);
      * BrushedMotor rightMotor(smartcarlib::pins::v2::rightMotorPins);
      * DifferentialControl control(leftMotor, rightMotor);
      *
-     * GY50 gyroscope(GYROSCOPE_OFFSET);
+     * ArduinoRuntime arduinoRuntime;
+     * const int GYROSCOPE_OFFSET = 37;
+     * GY50 gyroscope(arduinoRuntime, GYROSCOPE_OFFSET);
      * \endcode
      */
     HeadingCar(Control& control, HeadingSensor& headingSensor);

Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,14 @@ class HeadingCar : virtual public SimpleCar`
`17`	`17`	`*`
`18`	`18`	`* Example:`
`19`	`19`	`* \code`
`20`		`- * const int GYROSCOPE_OFFSET = 37;`
`21`	`20`	`*`
`22`	`21`	`* BrushedMotor leftMotor(smartcarlib::pins::v2::leftMotorPins);`
`23`	`22`	`* BrushedMotor rightMotor(smartcarlib::pins::v2::rightMotorPins);`
`24`	`23`	`* DifferentialControl control(leftMotor, rightMotor);`
`25`	`24`	`*`
`26`		`- * GY50 gyroscope(GYROSCOPE_OFFSET);`
	`25`	`+ * ArduinoRuntime arduinoRuntime;`
	`26`	`+ * const int GYROSCOPE_OFFSET = 37;`
	`27`	`+ * GY50 gyroscope(arduinoRuntime, GYROSCOPE_OFFSET);`
`27`	`28`	`* \endcode`
`28`	`29`	`*/`
`29`	`30`	`HeadingCar(Control& control, HeadingSensor& headingSensor);`