diff options
| author | Ryan <fauxpark@gmail.com> | 2023-03-22 14:32:49 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-22 14:32:49 +1100 |
| commit | 9c3c159286d20b05c3526ddb96661b10f706f222 (patch) | |
| tree | dafee995b475dadc8984cff3f452369b67278b33 /quantum/secure.h | |
| parent | 74c033eaf237a175bfb8168d3e2c82830f062004 (diff) | |
Update Doxygen comments for some headers (#20194)
Diffstat (limited to 'quantum/secure.h')
| -rw-r--r-- | quantum/secure.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/quantum/secure.h b/quantum/secure.h index bb2ba50f31..ae9b5b9045 100644 --- 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); + +/** \} */ |