Skip to content

Commit 95e2f06

Browse files
committed
Change examples command @brief to @details
The @brief doesn't work in the file list since there is no @file for the examples to avoid documenting the example functions as part of the library. Changing this to @details also fixes the double printed text on the example pages.
1 parent f044fb0 commit 95e2f06

6 files changed

Lines changed: 6 additions & 6 deletions

File tree

examples/Handbrake/HandbrakeJoystick/HandbrakeJoystick.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*/
2222

2323
/**
24-
* @brief Emulates the handbrake as a joystick over USB.
24+
* @details Emulates the handbrake as a joystick over USB.
2525
* @example HandbrakeJoystick.ino
2626
*/
2727

examples/Handbrake/HandbrakePrint/HandbrakePrint.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*/
2222

2323
/**
24-
* @brief Prints handbrake position percentage over Serial.
24+
* @details Prints handbrake position percentage over Serial.
2525
* @example HandbrakePrint.ino
2626
*/
2727

examples/Pedals/PedalsJoystick/PedalsJoystick.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*/
2222

2323
/**
24-
* @brief Emulates the pedals as a joystick over USB.
24+
* @details Emulates the pedals as a joystick over USB.
2525
* @example PedalsJoystick.ino
2626
*/
2727

examples/Pedals/PedalsPrint/PedalsPrint.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*/
2222

2323
/**
24-
* @brief Prints pedal position percentages over Serial.
24+
* @details Prints pedal position percentages over Serial.
2525
* @example PedalsPrint.ino
2626
*/
2727

examples/Shifter/ShiftJoystick/ShiftJoystick.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*/
2222

2323
/**
24-
* @brief Emulates the shifter as a joystick over USB.
24+
* @details Emulates the shifter as a joystick over USB.
2525
* @example ShiftJoystick.ino
2626
*/
2727

examples/Shifter/ShiftPrint/ShiftPrint.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*/
2222

2323
/**
24-
* @brief Reads and prints the current gear over serial.
24+
* @details Reads and prints the current gear over serial.
2525
* @example ShiftPrint.ino
2626
*/
2727

0 commit comments

Comments
 (0)