From f044fb0ad10de4cf3c0ebecc4147d9d3b09a7d09 Mon Sep 17 00:00:00 2001 From: David Madison Date: Sat, 21 Oct 2023 02:37:26 -0400 Subject: [PATCH 1/2] Enable Doxygen autobrief I just realized that autobrief was disabled, so all of the thorough documentation was stuck in the detail section... oops --- docs/Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index db64713..46015f7 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -209,7 +209,7 @@ SHORT_NAMES = NO # description.) # The default value is: NO. -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as From 95e2f065cc526e4a62f94653c715724d000573fc Mon Sep 17 00:00:00 2001 From: David Madison Date: Sat, 21 Oct 2023 02:40:31 -0400 Subject: [PATCH 2/2] 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. --- examples/Handbrake/HandbrakeJoystick/HandbrakeJoystick.ino | 2 +- examples/Handbrake/HandbrakePrint/HandbrakePrint.ino | 2 +- examples/Pedals/PedalsJoystick/PedalsJoystick.ino | 2 +- examples/Pedals/PedalsPrint/PedalsPrint.ino | 2 +- examples/Shifter/ShiftJoystick/ShiftJoystick.ino | 2 +- examples/Shifter/ShiftPrint/ShiftPrint.ino | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/Handbrake/HandbrakeJoystick/HandbrakeJoystick.ino b/examples/Handbrake/HandbrakeJoystick/HandbrakeJoystick.ino index 2418a4f..85ec61f 100644 --- 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 index 870727c..a49c47e 100644 --- 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 index 4c6a9c1..a50770a 100644 --- 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 index cb8c17b..395d7a8 100644 --- 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 index d0f0f37..6b36ef6 100644 --- 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 index f22a913..dbabb6f 100644 --- 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 */