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:45:41 GMT 2020


kossebau added a comment.


  Some similar macro definitions used by other projects, as I found by doing some random grepping over my system includes:
  
  - `__GTK_DOC_IGNORE__`
  - `Q_QDOC` & `Q_CLANG_QDOC`
  - `DO_NOT_DOCUMENT`
  - `EIGEN_PARSED_BY_DOXYGEN`
  - `DOXYGEN`
  - `U_IN_DOXYGEN`
  - `BOOST_DOXYGEN_INVOKED` & lots of similar
  - `CV_DOXYGEN`
  - `DOXYGEN_ENABLED`
  
  So seems there is no real standard sadly. Going for a `K_` prefix as namespace should also avoid any conflicts with potential definitions pulled in from others.
  
  If this is in, I would then also adapt all KF code as well as ECMADDQCH.

REPOSITORY
  R264 KApiDox

REVISION DETAIL
  https://phabricator.kde.org/D26602

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/f40a14aa/attachment.html>


More information about the Kde-frameworks-devel mailing list