9c3c159286d20b05c3526ddb96661b10f706f222

Author
Ryan <fauxpark@gmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

Update Doxygen comments for some headers (#20194)

Diff

  1diff --git a/drivers/lcd/hd44780.h b/drivers/lcd/hd44780.h
  2index 9e4333934447004fde0e43f9421cad15f8d618f7..402217a547a5a1cb99255d2984229440b28e6cfe 100644
  3--- a/drivers/lcd/hd44780.h
  4+++ b/drivers/lcd/hd44780.h
  5@@ -21,9 +21,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  6 #include <stdbool.h>
  7 
  8 /**
  9- * \defgroup hd44780
 10+ * \file
 11  *
 12- * HD44780 Character LCD Driver
 13+ * \defgroup hd44780 HD44780 Character LCD Driver
 14  * \{
 15  */
 16 
 17diff --git a/quantum/digitizer.h b/quantum/digitizer.h
 18index b826ba8ac870fb19cc58260fcb075396dbdbd9d4..6a9c24ed34df6c07b048dabc16e5123b32151a17 100644
 19--- a/quantum/digitizer.h
 20+++ b/quantum/digitizer.h
 21@@ -13,17 +13,15 @@
 22  * You should have received a copy of the GNU General Public License
 23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 24  */
 25-#pragma once
 26 
 27-#include "quantum.h"
 28+#pragma once
 29 
 30 #include <stdbool.h>
 31-#include <stdint.h>
 32 
 33 /**
 34- * \defgroup digitizer
 35+ * \file
 36  *
 37- * HID Digitizer
 38+ * defgroup digitizer HID Digitizer
 39  * \{
 40  */
 41 
 42diff --git a/quantum/joystick.h b/quantum/joystick.h
 43index 0ac99aa590d0d1192448d74099c1485d180c2d60..5de4ba66c6abd0914b7881c3726ecfe53ce2b508 100644
 44--- a/quantum/joystick.h
 45+++ b/quantum/joystick.h
 46@@ -22,9 +22,9 @@
 47 #include "gpio.h"
 48 
 49 /**
 50- * \defgroup joystick
 51+ * \file
 52  *
 53- * HID Joystick
 54+ * \defgroup joystick HID Joystick
 55  * \{
 56  */
 57 
 58diff --git a/quantum/leader.h b/quantum/leader.h
 59index 1999006c566f82f502f931a8df670e155eec304c..3177fcd1962c7f6e1e1a49999703495d45da2fef 100644
 60--- a/quantum/leader.h
 61+++ b/quantum/leader.h
 62@@ -5,9 +5,9 @@
 63 #include <stdint.h>
 64 
 65 /**
 66- * \defgroup leader
 67+ * \file
 68  *
 69- * Leader Key
 70+ * \defgroup leader Leader Key
 71  * \{
 72  */
 73 
 74diff --git a/quantum/programmable_button.h b/quantum/programmable_button.h
 75index e8c916d75c90c31c39558c67d386888152982c22..4c2cd534fe80ea71cc6c147cac09ec3427383622 100644
 76--- a/quantum/programmable_button.h
 77+++ b/quantum/programmable_button.h
 78@@ -21,9 +21,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 79 #include <stdbool.h>
 80 
 81 /**
 82- * \defgroup programmable_button
 83+ * \file
 84  *
 85- * HID Programmable Buttons
 86+ * \defgroup programmable_button HID Programmable Buttons
 87  * \{
 88  */
 89 
 90diff --git a/quantum/secure.h b/quantum/secure.h
 91index bb2ba50f31660c4b929ace1ddd76b18acbb36505..ae9b5b9045213c99853d6392c4d8c3dac77ac13e 100644
 92--- a/quantum/secure.h
 93+++ b/quantum/secure.h
 94@@ -3,10 +3,15 @@
 95 
 96 #pragma once
 97 
 98-/** \file
 99+/**
100+ * \file
101  *
102- * Exposes a set of functionality to act as a virtual padlock for your device
103- * ... As long as that padlock is made of paper and its currently raining.
104+ * \defgroup secure Secure API
105+ *
106+ * \brief Exposes a set of functionality to act as a virtual padlock for your device
107+ * ...as long as that padlock is made of paper and it's currently raining.
108+ *
109+ * \{
110  */
111 
112 #include <stdint.h>
113@@ -77,3 +82,5 @@ bool secure_hook_user(secure_status_t secure_status);
114 /** \brief keyboard hook called when changing secure status device
115  */
116 bool secure_hook_kb(secure_status_t secure_status);
117+
118+/** \} */
119diff --git a/quantum/send_string/send_string.h b/quantum/send_string/send_string.h
120index 4eb55b88dccc1ef6c8293bc62fc8c82ef4b7e6a9..dbaed43ebccb778948fd4df21781586bf3044cf6 100644
121--- a/quantum/send_string/send_string.h
122+++ b/quantum/send_string/send_string.h
123@@ -15,9 +15,11 @@
124  */
125 
126 /**
127- * \defgroup send_string
128+ * \file
129  *
130- * Send String API. These functions allow you to create macros by typing out sequences of keystrokes.
131+ * \defgroup send_string Send String API
132+ *
133+ * \brief These functions allow you to create macros by typing out sequences of keystrokes.
134  * \{
135  */
136