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.
dmadison · Oct 21, 2023 · 95e2f06 · 95e2f06
1 parent f044fb0
commit 95e2f06
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/examples/Handbrake/HandbrakeJoystick/HandbrakeJoystick.ino b/examples/Handbrake/HandbrakeJoystick/HandbrakeJoystick.ino
@@ -21,7 +21,7 @@
  */
 
  /**
- * @brief   Emulates the handbrake as a joystick over USB.
+ * @details Emulates the handbrake as a joystick over USB.
  * @example HandbrakeJoystick.ino
  */
 

diff --git a/examples/Handbrake/HandbrakePrint/HandbrakePrint.ino b/examples/Handbrake/HandbrakePrint/HandbrakePrint.ino
@@ -21,7 +21,7 @@
  */
 
  /**
- * @brief   Prints handbrake position percentage over Serial.
+ * @details Prints handbrake position percentage over Serial.
  * @example HandbrakePrint.ino
  */
 

diff --git a/examples/Pedals/PedalsJoystick/PedalsJoystick.ino b/examples/Pedals/PedalsJoystick/PedalsJoystick.ino
@@ -21,7 +21,7 @@
  */
 
  /**
- * @brief   Emulates the pedals as a joystick over USB.
+ * @details Emulates the pedals as a joystick over USB.
  * @example PedalsJoystick.ino
  */
 

diff --git a/examples/Pedals/PedalsPrint/PedalsPrint.ino b/examples/Pedals/PedalsPrint/PedalsPrint.ino
@@ -21,7 +21,7 @@
  */
 
  /**
- * @brief   Prints pedal position percentages over Serial.
+ * @details Prints pedal position percentages over Serial.
  * @example PedalsPrint.ino
  */
 

diff --git a/examples/Shifter/ShiftJoystick/ShiftJoystick.ino b/examples/Shifter/ShiftJoystick/ShiftJoystick.ino
@@ -21,7 +21,7 @@
  */
 
  /**
- * @brief   Emulates the shifter as a joystick over USB.
+ * @details Emulates the shifter as a joystick over USB.
  * @example ShiftJoystick.ino
  */
 

diff --git a/examples/Shifter/ShiftPrint/ShiftPrint.ino b/examples/Shifter/ShiftPrint/ShiftPrint.ino
@@ -21,7 +21,7 @@
  */
 
  /**
- * @brief   Reads and prints the current gear over serial.
+ * @details Reads and prints the current gear over serial.
  * @example ShiftPrint.ino
  */