Browse Source

Update Doxygen comments for some headers (#20194)

pull/20235/head
Ryan 1 year ago
committed by GitHub
parent
commit
9c3c159286
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 25 additions and 18 deletions
  1. +2
    -2
      drivers/lcd/hd44780.h
  2. +3
    -5
      quantum/digitizer.h
  3. +2
    -2
      quantum/joystick.h
  4. +2
    -2
      quantum/leader.h
  5. +2
    -2
      quantum/programmable_button.h
  6. +10
    -3
      quantum/secure.h
  7. +4
    -2
      quantum/send_string/send_string.h

+ 2
- 2
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>
/**
* \defgroup hd44780
* \file
*
* HD44780 Character LCD Driver
* \defgroup hd44780 HD44780 Character LCD Driver
* \{
*/


+ 3
- 5
quantum/digitizer.h View File

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


+ 2
- 2
quantum/joystick.h View File

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


+ 2
- 2
quantum/leader.h View File

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


+ 2
- 2
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>
/**
* \defgroup programmable_button
* \file
*
* HID Programmable Buttons
* \defgroup programmable_button HID Programmable Buttons
* \{
*/


+ 10
- 3
quantum/secure.h View File

@ -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>
@ -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);
/** \} */

+ 4
- 2
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.
* \{
*/


Loading…
Cancel
Save