darkkirb/qmk_firmware
1
0
Fork 0
forked from mirrors/qmk_firmware
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update Doxygen comments for some headers (#20194)

Browse source
This commit is contained in:
Ryan 2023-03-22 14:32:49 +11:00 committed by GitHub
parent 74c033eaf2
commit 9c3c159286
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 25 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
drivers/lcd/hd44780.h
View file

@ -21,9 +21,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <stdbool.h> #include <stdbool.h>
/** /**
* \defgroup hd44780 * \file
* *
* HD44780 Character LCD Driver * \defgroup hd44780 HD44780 Character LCD Driver
* \{ * \{
*/ */

8
quantum/digitizer.h
View file

@ -13,17 +13,15 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
#pragma once #pragma once
#include "quantum.h"
#include <stdbool.h> #include <stdbool.h>
#include <stdint.h>
/** /**
* \defgroup digitizer * \file
* *
* HID Digitizer * defgroup digitizer HID Digitizer
* \{ * \{
*/ */

4
quantum/joystick.h
View file

@ -22,9 +22,9 @@
#include "gpio.h" #include "gpio.h"
/** /**
* \defgroup joystick * \file
* *
* HID Joystick * \defgroup joystick HID Joystick
* \{ * \{
*/ */

4
quantum/leader.h
View file

@ -5,9 +5,9 @@
#include <stdint.h> #include <stdint.h>
/** /**
* \defgroup leader * \file
* *
* Leader Key * \defgroup leader Leader Key
* \{ * \{
*/ */

4
quantum/programmable_button.h
View file

@ -21,9 +21,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <stdbool.h> #include <stdbool.h>
/** /**
* \defgroup programmable_button * \file
* *
* HID Programmable Buttons * \defgroup programmable_button HID Programmable Buttons
* \{ * \{
*/ */

13
quantum/secure.h
View file

@ -3,10 +3,15 @@
#pragma once #pragma once
/** \file /**
* \file
* *
* Exposes a set of functionality to act as a virtual padlock for your device * \defgroup secure Secure API
* ... As long as that padlock is made of paper and its currently raining. *
* \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> #include <stdint.h>
@ -77,3 +82,5 @@ bool secure_hook_user(secure_status_t secure_status);
/** \brief keyboard hook called when changing secure status device /** \brief keyboard hook called when changing secure status device
*/ */
bool secure_hook_kb(secure_status_t secure_status); bool secure_hook_kb(secure_status_t secure_status);
/** \} */

6
quantum/send_string/send_string.h
View file

@ -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.
* \{ * \{
*/ */