summaryrefslogtreecommitdiffstats
path: root/testing/004_arg.dox
diff options
context:
space:
mode:
authorVladimír Vondruš <mosra@centrum.cz>2019-01-01 17:01:22 (GMT)
committerVladimír Vondruš <mosra@centrum.cz>2019-01-03 10:32:17 (GMT)
commitd18b3eaf3486e224fa9de7e77b536883952b40b9 (patch)
tree045620bc9c59d68e2fb32bf035f0147e164a360b /testing/004_arg.dox
parent3b2198babbaf8edafe03e5298e7c194763a1f9fa (diff)
downloadDoxygen-d18b3eaf3486e224fa9de7e77b536883952b40b9.zip
Doxygen-d18b3eaf3486e224fa9de7e77b536883952b40b9.tar.gz
Doxygen-d18b3eaf3486e224fa9de7e77b536883952b40b9.tar.bz2
Implement a new EXTRACT_PRIVATE_VIRTUAL option.
The classic article about virtuality from Herb Sutter [1] suggests that virtual functions are always private and public class interface is never virtual. Until now, it was not really possible to document these functions in Doxygen: * Enabling EXTRACT_PRIVATE would show all internals, not just virtual functions, which is not wanted. * Enabling HIDE_UNDOC_MEMBERS and HIDE_UNDOC_CLASSES would effectively disable warnings about *all* undocumented members, which is not wanted. The usual workaround was to put the members into protected scope just for Doxygen: #ifdef DOXYGEN_GENERATING_OUTPUT protected: #else private: #endif /** @brief Documented private virtual function */ virtual doStuff(); The new EXTRACT_PRIVATE_VIRTUAL option makes these visible (and able to be linked to), but shows them *only* if they are documented. [1] http://www.gotw.ca/publications/mill18.htm
Diffstat (limited to 'testing/004_arg.dox')
0 files changed, 0 insertions, 0 deletions