update the docs

1 files changed, 35 insertions, 12 deletions

diff --git a/include/aesni/raw.h b/include/aesni/raw.h
index 2a1902e..4b35266 100644
--- a/include/aesni/raw.h
+++ b/include/aesni/raw.h
@@ -41,7 +41,12 @@ extern "C"
 #endif
 
 /**
- * Expands a key schedule for AES-128 encryption.
+ * \defgroup aesni_raw_api_aes128 AES-128
+ * \{
+ */
+
+/**
+ * \brief Expands a key schedule for AES-128 encryption.
  *
  * \param[in] key The AES-128 key.
  * \param[out] key_schedule The AES-128 encryption key schedule. Must not be `NULL`.
@@ -51,7 +56,7 @@ void __fastcall aesni_raw_expand_key_schedule128(
     AesNI_KeySchedule128* key_schedule);
 
 /**
- * "Reverses" a key schedule for AES-128 "equivalent inverse cipher" decryption.
+ * \brief "Reverses" a key schedule for AES-128 "equivalent inverse cipher" decryption.
  *
  * \param[in] key_schedule The AES-128 encryption key schedule. Must not be `NULL`.
  * \param[out] inverted_schedule The AES-128 decryption key schedule. Must not be `NULL`.
@@ -61,7 +66,7 @@ void __fastcall aesni_raw_invert_key_schedule128(
     AesNI_KeySchedule128* inverted_schedule);
 
 /**
- * Encrypts a 128-bit block using AES-128.
+ * \brief Encrypts a 128-bit block using AES-128.
  *
  * \param[in] plain The plaintext to be encrypted.
  * \param[in] key_schedule The AES-128 encryption key schedule. Must not be `NULL`.
@@ -72,7 +77,7 @@ AesNI_Block128 __fastcall aesni_raw_encrypt_block128(
     AesNI_KeySchedule128* key_schedule);
 
 /**
- * Decrypts a 128-bit block using AES-128.
+ * \brief Decrypts a 128-bit block using AES-128.
  *
  * \param[in] cipher The ciphertext to be decrypted.
  * \param[in] inverted_schedule The AES-128 decryption ("reversed") key schedule. Must not be `NULL`.
@@ -83,7 +88,14 @@ AesNI_Block128 __fastcall aesni_raw_decrypt_block128(
     AesNI_KeySchedule128* inverted_schedule);
 
 /**
- * Expands a key schedule for AES-192 encryption.
+ * \}
+ *
+ * \defgroup aesni_raw_api_aes192 AES-192
+ * \{
+ */
+
+/**
+ * \brief Expands a key schedule for AES-192 encryption.
  *
  * \param[in] key_lo The least significant part of the AES-192 key.
  * \param[in] key_hi The most significant part of the AES-192 key.
@@ -95,7 +107,7 @@ void __fastcall aesni_raw_expand_key_schedule192(
     AesNI_KeySchedule192* key_schedule);
 
 /**
- * "Reverses" a key schedule for AES-192 "equivalent inverse cipher" decryption.
+ * \brief "Reverses" a key schedule for AES-192 "equivalent inverse cipher" decryption.
  *
  * \param[in] key_schedule The AES-192 encryption key schedule. Must not be `NULL`.
  * \param[out] inverted_schedule The AES-192 decryption key schedule. Must not be `NULL`.
@@ -105,7 +117,7 @@ void __fastcall aesni_raw_invert_key_schedule192(
     AesNI_KeySchedule192* inverted_schedule);
 
 /**
- * Encrypts a 128-bit block using AES-192.
+ * \brief Encrypts a 128-bit block using AES-192.
  *
  * \param[in] plain The plaintext to be encrypted.
  * \param[in] key_schedule The AES-192 encryption key schedule. Must not be `NULL`.
@@ -116,7 +128,7 @@ AesNI_Block128 __fastcall aesni_raw_encrypt_block192(
     AesNI_KeySchedule192* key_schedule);
 
 /**
- * Decrypts a 128-bit block using AES-192.
+ * \brief Decrypts a 128-bit block using AES-192.
  *
  * \param[in] cipher The ciphertext to be decrypted.
  * \param[in] inverted_schedule The AES-192 decryption ("reversed") key schedule. Must not be `NULL`.
@@ -127,7 +139,14 @@ AesNI_Block128 __fastcall aesni_raw_decrypt_block192(
     AesNI_KeySchedule192* inverted_schedule);
 
 /**
- * Expands a key schedule for AES-256 encryption.
+ * \}
+ *
+ * \defgroup aesni_raw_api_aes256 AES-256
+ * \{
+ */
+
+/**
+ * \brief Expands a key schedule for AES-256 encryption.
  *
  * \param[in] key_lo The least significant part of the AES-256 key.
  * \param[in] key_hi The most significant part of the AES-256 key.
@@ -139,7 +158,7 @@ void __fastcall aesni_raw_expand_key_schedule256(
     AesNI_KeySchedule256* key_schedule);
 
 /**
- * "Reverses" a key schedule for AES-256 "equivalent inverse cipher" decryption.
+ * \brief "Reverses" a key schedule for AES-256 "equivalent inverse cipher" decryption.
  *
  * \param[in] key_schedule The AES-256 encryption key schedule. Must not be `NULL`.
  * \param[out] inverted_schedule The AES-256 decryption key schedule. Must not be `NULL`.
@@ -149,7 +168,7 @@ void __fastcall aesni_raw_invert_key_schedule256(
     AesNI_KeySchedule256* inverted_schedule);
 
 /**
- * Encrypts a 128-bit block using AES-256.
+ * \brief Encrypts a 128-bit block using AES-256.
  *
  * \param[in] plain The plaintext to be encrypted.
  * \param[in] key_schedule The AES-256 encryption key schedule. Must not be `NULL`.
@@ -160,7 +179,7 @@ AesNI_Block128 __fastcall aesni_raw_encrypt_block256(
     AesNI_KeySchedule256* key_schedule);
 
 /**
- * Decrypts a 128-bit block using AES-256.
+ * \brief Decrypts a 128-bit block using AES-256.
  *
  * \param[in] cipher The ciphertext to be decrypted.
  * \param[in] inverted_schedule The AES-256 decryption ("reversed") key schedule. Must not be `NULL`.
@@ -170,6 +189,10 @@ AesNI_Block128 __fastcall aesni_raw_decrypt_block256(
     AesNI_Block128 cipher,
     AesNI_KeySchedule256* inverted_schedule);
 
+/**
+ * \}
+ */
+
 #ifdef __cplusplus
 }
 #endif