Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen Fixes #14

Merged
merged 2 commits into from
Oct 21, 2023
Merged

Doxygen Fixes #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f044fb0
Enable Doxygen autobrief
dmadison Oct 21, 2023
95e2f06
Change examples command @brief to @details
dmadison Oct 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/Handbrake/HandbrakeJoystick/HandbrakeJoystick.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion examples/Handbrake/HandbrakePrint/HandbrakePrint.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/

/**
* @brief Prints handbrake position percentage over Serial.
* @details Prints handbrake position percentage over Serial.
* @example HandbrakePrint.ino
*/

Expand Down
2 changes: 1 addition & 1 deletion examples/Pedals/PedalsJoystick/PedalsJoystick.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion examples/Pedals/PedalsPrint/PedalsPrint.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/

/**
* @brief Prints pedal position percentages over Serial.
* @details Prints pedal position percentages over Serial.
* @example PedalsPrint.ino
*/

Expand Down
2 changes: 1 addition & 1 deletion examples/Shifter/ShiftJoystick/ShiftJoystick.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion examples/Shifter/ShiftPrint/ShiftPrint.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down