From: Vladimír Vondruš Date: Thu, 7 May 2020 14:01:56 +0000 (+0200) Subject: documentation/doxygen: thanks for new bugs, 1.8.17. X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=22030fefc3c98c2b8686454a37f0b6090d996242;p=blog.git documentation/doxygen: thanks for new bugs, 1.8.17. --- diff --git a/documentation/test_doxygen/compound_deprecated/Dir/DeprecatedFile.h b/documentation/test_doxygen/compound_deprecated/Dir/DeprecatedFile.h index a95626f4..ae69d6e1 100644 --- a/documentation/test_doxygen/compound_deprecated/Dir/DeprecatedFile.h +++ b/documentation/test_doxygen/compound_deprecated/Dir/DeprecatedFile.h @@ -82,7 +82,11 @@ union DeprecatedUnion {}; */ struct DeprecatedStruct {}; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @defgroup deprecated-group A group * @ingroup group diff --git a/documentation/test_doxygen/compound_includes/First.h b/documentation/test_doxygen/compound_includes/First.h index 59945264..40c92a22 100644 --- a/documentation/test_doxygen/compound_includes/First.h +++ b/documentation/test_doxygen/compound_includes/First.h @@ -41,7 +41,11 @@ void bar(); /** @brief Variable in a group */ constexpr void* variable = nullptr; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } @@ -74,7 +78,11 @@ void bar(); /** @brief Variable in a group */ constexpr void* variable = nullptr; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } @@ -110,7 +118,11 @@ void foo(); /** @brief A define */ #define A_DEFINE -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @brief This namespace should not have a global include diff --git a/documentation/test_doxygen/compound_includes/Second.h b/documentation/test_doxygen/compound_includes/Second.h index 9d286afe..2fa0e554 100644 --- a/documentation/test_doxygen/compound_includes/Second.h +++ b/documentation/test_doxygen/compound_includes/Second.h @@ -16,7 +16,11 @@ void foo(); /** @brief Flag in a group */ enum Flag {}; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @related Class * @brief A related enum in a different file diff --git a/documentation/test_doxygen/compound_includes_undocumented_files/First.h b/documentation/test_doxygen/compound_includes_undocumented_files/First.h index 5a18d9ac..338e898a 100644 --- a/documentation/test_doxygen/compound_includes_undocumented_files/First.h +++ b/documentation/test_doxygen/compound_includes_undocumented_files/First.h @@ -40,7 +40,11 @@ void bar(); /** @brief Variable in a group */ constexpr void* variable = nullptr; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } @@ -73,7 +77,11 @@ void bar(); /** @brief Variable in a group */ constexpr void* variable = nullptr; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } @@ -109,4 +117,8 @@ void foo(); /** @brief A define */ #define A_DEFINE -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ diff --git a/documentation/test_doxygen/compound_includes_undocumented_files/Second.h b/documentation/test_doxygen/compound_includes_undocumented_files/Second.h index ab49200b..226242b2 100644 --- a/documentation/test_doxygen/compound_includes_undocumented_files/Second.h +++ b/documentation/test_doxygen/compound_includes_undocumented_files/Second.h @@ -15,7 +15,11 @@ void foo(); /** @brief Flag in a group */ enum Flag {}; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @related Class * @brief A related enum in a different file diff --git a/documentation/test_doxygen/compound_listing/Directory/File.h b/documentation/test_doxygen/compound_listing/Directory/File.h index d86f907c..820ced1e 100644 --- a/documentation/test_doxygen/compound_listing/Directory/File.h +++ b/documentation/test_doxygen/compound_listing/Directory/File.h @@ -45,7 +45,11 @@ constexpr void* variable = nullptr; /** @brief A define in a group */ #define A_DEFINE_IN_A_GROUP -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ }} diff --git a/documentation/test_doxygen/compound_listing/Directory/Sub/Class.h b/documentation/test_doxygen/compound_listing/Directory/Sub/Class.h index 7b12ba85..d5ca95cb 100644 --- a/documentation/test_doxygen/compound_listing/Directory/Sub/Class.h +++ b/documentation/test_doxygen/compound_listing/Directory/Sub/Class.h @@ -56,7 +56,11 @@ class Class { void undocumented(); - /*@}*/ + /* Since 1.8.17, the original short-hand group closing doesn't work + anymore. FFS. */ + /** + * @} + */ protected: /** @brief A protected subclass */ @@ -90,7 +94,11 @@ class Class { /** @brief A member that gets ignored because the group has no name */ int member; - /*@}*/ + /* Since 1.8.17, the original short-hand group closing doesn't work + anymore. FFS. */ + /** + * @} + */ /** @{ @name Group full of non-public stuff which should be marked as such */ @@ -113,7 +121,11 @@ class Class { /** @brief Private non-virtual function in a group shouldn't appear in the docs */ int doStuffIgnored(); - /*@}*/ + /* Since 1.8.17, the original short-hand group closing doesn't work + anymore. FFS. */ + /** + * @} + */ /** @brief This shouldn't appear in the docs */ class Private {}; diff --git a/documentation/test_doxygen/compound_modules/input.h b/documentation/test_doxygen/compound_modules/input.h index c795f7f8..35ed583c 100644 --- a/documentation/test_doxygen/compound_modules/input.h +++ b/documentation/test_doxygen/compound_modules/input.h @@ -6,7 +6,11 @@ Detailed description. /** @brief A foo */ void foo(); -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @defgroup group2 Another group @brief Brief description @@ -15,7 +19,11 @@ void foo(); /** @brief A bar */ void bar(); -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @defgroup subgroup A subgroup diff --git a/documentation/test_doxygen/compound_modules_in_namespace/file1.h b/documentation/test_doxygen/compound_modules_in_namespace/file1.h index 7a930c15..46f21f90 100644 --- a/documentation/test_doxygen/compound_modules_in_namespace/file1.h +++ b/documentation/test_doxygen/compound_modules_in_namespace/file1.h @@ -43,6 +43,10 @@ Detailed description. */ constexpr FooBar FizzBuzz = 5; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } diff --git a/documentation/test_doxygen/compound_modules_in_namespace/file2.h b/documentation/test_doxygen/compound_modules_in_namespace/file2.h index 499247ae..94f3d512 100644 --- a/documentation/test_doxygen/compound_modules_in_namespace/file2.h +++ b/documentation/test_doxygen/compound_modules_in_namespace/file2.h @@ -30,6 +30,10 @@ With details. */ enum Enum {}; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } diff --git a/documentation/test_doxygen/compound_namespace_members_in_file_scope_define_base_url/File.h b/documentation/test_doxygen/compound_namespace_members_in_file_scope_define_base_url/File.h index 80efff81..70147193 100644 --- a/documentation/test_doxygen/compound_namespace_members_in_file_scope_define_base_url/File.h +++ b/documentation/test_doxygen/compound_namespace_members_in_file_scope_define_base_url/File.h @@ -14,7 +14,11 @@ namespace NS { int var; /**< @brief A variable */ -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } diff --git a/documentation/test_doxygen/contents_anchor_in_both_group_and_namespace/File.h b/documentation/test_doxygen/contents_anchor_in_both_group_and_namespace/File.h index bb33bf3d..3673bc17 100644 --- a/documentation/test_doxygen/contents_anchor_in_both_group_and_namespace/File.h +++ b/documentation/test_doxygen/contents_anchor_in_both_group_and_namespace/File.h @@ -1,7 +1,11 @@ /** @defgroup fizzbuzz A group @{ */ -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @brief Foo */ namespace Foo { diff --git a/documentation/test_doxygen/cpp_friends/File.h b/documentation/test_doxygen/cpp_friends/File.h index 775d5802..848ae8d7 100644 --- a/documentation/test_doxygen/cpp_friends/File.h +++ b/documentation/test_doxygen/cpp_friends/File.h @@ -40,7 +40,11 @@ class Class { /** @brief A friend grouped function */ friend void friendGroupedFunction(); - /*@}*/ + /* Since 1.8.17, the original short-hand group closing doesn't work + anymore. FFS. */ + /** + * @} + */ }; /** @brief Class with template parameters */ diff --git a/documentation/test_doxygen/cpp_signals_slots/File.h b/documentation/test_doxygen/cpp_signals_slots/File.h index c8d7b37a..691076b8 100644 --- a/documentation/test_doxygen/cpp_signals_slots/File.h +++ b/documentation/test_doxygen/cpp_signals_slots/File.h @@ -84,5 +84,9 @@ class Class { */ void privateGroupedSlot(); - /*@}*/ + /* Since 1.8.17, the original short-hand group closing doesn't work + anymore. FFS. */ + /** + * @} + */ }; diff --git a/documentation/test_doxygen/page_empty_page/input.h b/documentation/test_doxygen/page_empty_page/input.h index 14461ab2..c95b5fd9 100644 --- a/documentation/test_doxygen/page_empty_page/input.h +++ b/documentation/test_doxygen/page_empty_page/input.h @@ -11,4 +11,8 @@ class Bar {}; } -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ diff --git a/documentation/test_doxygen/search/DeprecatedDir/DeprecatedFile.h b/documentation/test_doxygen/search/DeprecatedDir/DeprecatedFile.h index a38bd734..882268ca 100644 --- a/documentation/test_doxygen/search/DeprecatedDir/DeprecatedFile.h +++ b/documentation/test_doxygen/search/DeprecatedDir/DeprecatedFile.h @@ -58,6 +58,8 @@ enum class Enum { /** @defgroup deprecated-group A group * @deprecated This group is deprecated. + * + * @{ */ /** @@ -72,7 +74,11 @@ union DeprecatedUnion {}; */ struct DeprecatedStruct {}; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } diff --git a/documentation/test_doxygen/search/Dir/File.h b/documentation/test_doxygen/search/Dir/File.h index 9ca24084..f080ea67 100644 --- a/documentation/test_doxygen/search/Dir/File.h +++ b/documentation/test_doxygen/search/Dir/File.h @@ -95,7 +95,11 @@ union Union {}; */ struct Struct {}; -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ } diff --git a/documentation/test_doxygen/undocumented/Directory/File.h b/documentation/test_doxygen/undocumented/Directory/File.h index ce6f3812..f17c5c4e 100644 --- a/documentation/test_doxygen/undocumented/Directory/File.h +++ b/documentation/test_doxygen/undocumented/Directory/File.h @@ -96,7 +96,11 @@ constexpr void* variableInAGroup = nullptr; /* An undocumented define in a group */ #define A_DEFINE_IN_A_GROUP -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ /** @defgroup group A module @{ */ @@ -125,7 +129,11 @@ constexpr const int VarInModule = 3; /* An undocumented function in a module */ void fooInModule(); -/*@}*/ +/* Since 1.8.17, the original short-hand group closing doesn't work anymore. + FFS. */ +/** + * @} + */ }}