From 3b5906f40efe14262fe1fe54b3bcab1878f9dac7 Mon Sep 17 00:00:00 2001 From: flobernd Date: Mon, 11 Sep 2017 03:05:49 +0200 Subject: [PATCH] Fixed doxygen comments for generated enums --- include/Zydis/Generated/EnumISAExt.h | 6 ++++++ include/Zydis/Generated/EnumISASet.h | 6 ++++++ include/Zydis/Generated/EnumInstructionCategory.h | 6 ++++++ include/Zydis/Generated/EnumMnemonic.h | 6 ++++++ include/Zydis/MetaInfo.h | 11 ----------- include/Zydis/Mnemonic.h | 3 --- 6 files changed, 24 insertions(+), 14 deletions(-) diff --git a/include/Zydis/Generated/EnumISAExt.h b/include/Zydis/Generated/EnumISAExt.h index 80e1407..d61563c 100644 --- a/include/Zydis/Generated/EnumISAExt.h +++ b/include/Zydis/Generated/EnumISAExt.h @@ -1,5 +1,11 @@ +/** + * @brief Defines the `ZydisISAExt` datatype. + */ typedef uint8_t ZydisISAExt; +/** + * @brief Values that represent `ZydisISAExt` elements. + */ enum ZydisISAExts { ZYDIS_ISA_EXT_INVALID, diff --git a/include/Zydis/Generated/EnumISASet.h b/include/Zydis/Generated/EnumISASet.h index d18b1b6..25a12c6 100644 --- a/include/Zydis/Generated/EnumISASet.h +++ b/include/Zydis/Generated/EnumISASet.h @@ -1,5 +1,11 @@ +/** + * @brief Defines the `ZydisISASet` datatype. + */ typedef uint8_t ZydisISASet; +/** + * @brief Values that represent `ZydisISASet` elements. + */ enum ZydisISASets { ZYDIS_ISA_SET_INVALID, diff --git a/include/Zydis/Generated/EnumInstructionCategory.h b/include/Zydis/Generated/EnumInstructionCategory.h index d7d0816..e2dd0b6 100644 --- a/include/Zydis/Generated/EnumInstructionCategory.h +++ b/include/Zydis/Generated/EnumInstructionCategory.h @@ -1,5 +1,11 @@ +/** + * @brief Defines the `ZydisInstructionCategory` datatype. + */ typedef uint8_t ZydisInstructionCategory; +/** + * @brief Values that represent `ZydisInstructionCategory` elements. + */ enum ZydisInstructionCategories { ZYDIS_CATEGORY_INVALID, diff --git a/include/Zydis/Generated/EnumMnemonic.h b/include/Zydis/Generated/EnumMnemonic.h index 7181e42..b78966b 100644 --- a/include/Zydis/Generated/EnumMnemonic.h +++ b/include/Zydis/Generated/EnumMnemonic.h @@ -1,5 +1,11 @@ +/** + * @brief Defines the `ZydisMnemonic` datatype. + */ typedef uint16_t ZydisMnemonic; +/** + * @brief Values that represent `ZydisMnemonic` elements. + */ enum ZydisMnemonics { ZYDIS_MNEMONIC_INVALID, diff --git a/include/Zydis/MetaInfo.h b/include/Zydis/MetaInfo.h index 542cf3e..ef5fb3b 100644 --- a/include/Zydis/MetaInfo.h +++ b/include/Zydis/MetaInfo.h @@ -43,19 +43,8 @@ extern "C" { /* Enums and types */ /* ============================================================================================== */ -/** - * @brief Defines the @c ZydisInstructionCategory datatype. - */ #include - -/** - * @brief Defines the @c ZydisISASet datatype. - */ #include - -/** - * @brief Defines the @c ZydisISAExt datatype. - */ #include /* ============================================================================================== */ diff --git a/include/Zydis/Mnemonic.h b/include/Zydis/Mnemonic.h index ee40e92..527532e 100644 --- a/include/Zydis/Mnemonic.h +++ b/include/Zydis/Mnemonic.h @@ -43,9 +43,6 @@ extern "C" { /* Enums and types */ /* ============================================================================================== */ -/** - * @brief Defines the @c ZydisMnemonic datatype. - */ #include /* ============================================================================================== */