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

Jump to bottom

Update Doxygen comments for some headers #20194

Merged
merged 1 commit into from
Mar 22, 2023
Merged

Update Doxygen comments for some headers #20194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions drivers/lcd/hd44780.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <stdbool.h>

/**
* \defgroup hd44780
* \file
*
* HD44780 Character LCD Driver
* \defgroup hd44780 HD44780 Character LCD Driver
* \{
*/

Expand Down
8 changes: 3 additions & 5 deletions quantum/digitizer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,15 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once

#include "quantum.h"
#pragma once

#include <stdbool.h>
#include <stdint.h>

/**
* \defgroup digitizer
* \file
*
* HID Digitizer
* defgroup digitizer HID Digitizer
* \{
*/

Expand Down
4 changes: 2 additions & 2 deletions quantum/joystick.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
#include "gpio.h"

/**
* \defgroup joystick
* \file
*
* HID Joystick
* \defgroup joystick HID Joystick
* \{
*/

Expand Down
4 changes: 2 additions & 2 deletions quantum/leader.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
#include <stdint.h>

/**
* \defgroup leader
* \file
*
* Leader Key
* \defgroup leader Leader Key
* \{
*/

Expand Down
4 changes: 2 additions & 2 deletions quantum/programmable_button.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <stdbool.h>

/**
* \defgroup programmable_button
* \file
*
* HID Programmable Buttons
* \defgroup programmable_button HID Programmable Buttons
* \{
*/

Expand Down
13 changes: 10 additions & 3 deletions quantum/secure.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,15 @@

#pragma once

/** \file
/**
* \file
*
* Exposes a set of functionality to act as a virtual padlock for your device
* ... As long as that padlock is made of paper and its currently raining.
* \defgroup secure Secure API
*
* \brief Exposes a set of functionality to act as a virtual padlock for your device
* ...as long as that padlock is made of paper and it's currently raining.
*
* \{
*/

#include <stdint.h>
Expand Down Expand Up @@ -77,3 +82,5 @@ bool secure_hook_user(secure_status_t secure_status);
/** \brief keyboard hook called when changing secure status device
*/
bool secure_hook_kb(secure_status_t secure_status);

/** \} */
6 changes: 4 additions & 2 deletions quantum/send_string/send_string.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
*/

/**
* \defgroup send_string
* \file
*
* Send String API. These functions allow you to create macros by typing out sequences of keystrokes.
* \defgroup send_string Send String API
*
* \brief These functions allow you to create macros by typing out sequences of keystrokes.
* \{
*/

Expand Down