ICU-13810 Doxygen warning cleanup. #29
Conversation
|
|
| # define U_NOEXCEPT | ||
| #elif U_CPLUSPLUS_VERSION >= 11 || __has_feature(cxx_noexcept) || __has_extension(cxx_noexcept) \ | ||
| || (defined(_MSC_VER) && _MSC_VER >= 1900) /* Visual Studio 2015 */ | ||
| # define U_NOEXCEPT noexcept |
There was a problem hiding this comment.
I think VS2015 is still technically a supported platform? Though perhaps this could be reconsidered?
There was a problem hiding this comment.
I think VS 2015 is OK. It has MSC_VER==1900, so the original condition is met and U_NOEXCEPT is defined to be noexcept, which is what the new version does unconditionally.
Where things could differ is if _HAS_EXCEPTIONS == 0. I'm hoping it will be OK because we are restricting ourselves to compilers new enough to recognize noexcept as a keyword, which shouldn't depend on _HAS_EXCEPTIONS.
There was a problem hiding this comment.
Ah, good point. Yes, the define would be unchanged for VS2015. (Thanks).
I believe the macro _HAS_EXCEPTIONS is really only for the STL library though (possibly just the MSVC STL), so I don't think having it set or not would affect the core language itself.
Summary of types of changes to API documentation to remove Doxygen warnings:
Doxyfile.in: upgraded using the tooling provided with the latest Doxygen, resulting in file reformatting, removal of obsolete items, and addition of new items. Doxygen was warning that the old config file was out-of-date.
U_NOEXCEPT, U_OVERRIDE, U_FINAL definitions had complicated conditionals based on platform and C++ language level that confused Doxygen. Since we now require a reasonably conforming C++ 11, I deleted many of these conditionals.
Warnings for missing docs on forward declarations, @internal classes, and similar: Use Doxygen \cond ... \endcond to skip the declarations.
html vs. Markdown style docs. Some of the html markup, probably originating from JavaDoc, was not working with Doxygen. Changed to markdown. Sometimes changed other adjacent markup also, to avoid a confusing mixture of styles. (Markdown seems to be Doxygen's preferred style, and definitely makes for much cleaner header files, which is also important.)
Fixed various typos, missing docs, etc.
NumberFormatter errors. Not fixed. These will be done by Shane.