diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 17:53:49 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 18:27:40 +0200 |
| commit | 08b0e02f8ecd3cec4840f5025729e5b40d890645 (patch) | |
| tree | e09e23d4b7f1481d0c2edf600e5a2ef2c179be89 | |
| parent | 8ca7a8f13c47c66ed31bb2799e31cf490be86dc6 (diff) | |
| download | extra-cmake-modules-08b0e02f8ecd3cec4840f5025729e5b40d890645.tar.gz extra-cmake-modules-08b0e02f8ecd3cec4840f5025729e5b40d890645.tar.bz2 | |
API dox: ECMGenerateExportHeader turn note about BIC hiding into warning
NO_CHANGELOG
| -rw-r--r-- | modules/ECMGenerateExportHeader.cmake | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/modules/ECMGenerateExportHeader.cmake b/modules/ECMGenerateExportHeader.cmake index e8e1fb16..a548e927 100644 --- a/modules/ECMGenerateExportHeader.cmake +++ b/modules/ECMGenerateExportHeader.cmake @@ -177,18 +177,19 @@ When the ``GROUP_BASE_NAME`` has been used, the same macros but with the given ``<group_base_name>`` prefix are available to define the defaults of these macros, if not explicitly set. -Note: The tricks applied here for hiding deprecated API to the compiler -when building against a library do not work for all deprecated API: - -* virtual methods need to stay visible to the compiler to build proper - virtual method tables for subclasses -* enumerators from enums cannot be simply removed, as this changes - auto values of following enumerators, also can poke holes in enumerator - series used as index into tables - -In such cases the API can be only "hidden" at build time of the library, -itself, by generated hard coded macro settings, using -``<prefix_name><uppercase_base_name>_BUILD_DEPRECATED_SINCE(major, minor)``. +.. warning:: + The tricks applied here for hiding deprecated API to the compiler + when building against a library do not work for all deprecated API: + + * virtual methods need to stay visible to the compiler to build proper + virtual method tables for subclasses + * enumerators from enums cannot be simply removed, as this changes + auto values of following enumerators, also can poke holes in enumerator + series used as index into tables + + In such cases the API can be only "hidden" at build time of the library, + itself, by generated hard coded macro settings, using + ``<prefix_name><uppercase_base_name>_BUILD_DEPRECATED_SINCE(major, minor)``. Examples: |