D26602: Define K_DOXYGEN as macro to check if kapidox/doxygen is run
Friedrich W. H. Kossebau
noreply at phabricator.kde.org
Sun Jan 12 10:40:32 GMT 2020
kossebau created this revision.
kossebau added a reviewer: Frameworks.
Herald added projects: Frameworks, Documentation.
Herald added subscribers: kde-doc-english, kde-frameworks-devel.
kossebau requested review of this revision.
REVISION SUMMARY
Currently kapidox uses the macro DOXYGEN_SHOULD_SKIP_THIS to enable code
it processes to control what doxygen sees. That macro, while taken from
the example given in the official doxygen documentation,
( http://www.doxygen.nl/manual/faq.html#faq_code ) has some disadvantages:
- it is not a macro officially set by doxygen
- its semantic can be confusing to human readers in case it needs to be used with #ifdef instead of the #ifndef as in the doxygen documentation example
Example:
#ifdef DOXYGEN_SHOULD_SKIP_THIS
// will this code be processed by kapidox/doxygen? Yes, it will
#endif
Using a K_DOXYGEN macro definition instead follows an existing pattern
known from code checking the (compiler) tool being processed by, like
__GNUC__, __clang__ or Q_QDOC.
REPOSITORY
R264 KApiDox
BRANCH
introduceK_DOXYGEN
REVISION DETAIL
https://phabricator.kde.org/D26602
AFFECTED FILES
README.md
src/kapidox/data/Doxyfile.global
To: kossebau, #frameworks
Cc: kde-frameworks-devel, kde-doc-english, LeGast00n, gennad, fbampaloukas, GB_2, michaelh, ngraham, bruns, skadinna
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20200112/e078a410/attachment.html>
More information about the Kde-frameworks-devel
mailing list