commit 9c3c159286d20b05c3526ddb96661b10f706f222
parent 74c033eaf237a175bfb8168d3e2c82830f062004
Author: Ryan <fauxpark@gmail.com>
Date: Wed, 22 Mar 2023 14:32:49 +1100
Update Doxygen comments for some headers (#20194)
Diffstat:
7 files changed, 25 insertions(+), 18 deletions(-)
diff --git a/drivers/lcd/hd44780.h b/drivers/lcd/hd44780.h
@@ -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
* \{
*/
diff --git a/quantum/digitizer.h b/quantum/digitizer.h
@@ -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
* \{
*/
diff --git a/quantum/joystick.h b/quantum/joystick.h
@@ -22,9 +22,9 @@
#include "gpio.h"
/**
- * \defgroup joystick
+ * \file
*
- * HID Joystick
+ * \defgroup joystick HID Joystick
* \{
*/
diff --git a/quantum/leader.h b/quantum/leader.h
@@ -5,9 +5,9 @@
#include <stdint.h>
/**
- * \defgroup leader
+ * \file
*
- * Leader Key
+ * \defgroup leader Leader Key
* \{
*/
diff --git a/quantum/programmable_button.h b/quantum/programmable_button.h
@@ -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
* \{
*/
diff --git a/quantum/secure.h b/quantum/secure.h
@@ -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);
+
+/** \} */
diff --git a/quantum/send_string/send_string.h b/quantum/send_string/send_string.h
@@ -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.
* \{
*/
