<table><tr><td style="">kossebau created this revision.<br />kossebau added a reviewer: Frameworks.<br />Herald added projects: Frameworks, Documentation.<br />Herald added subscribers: kde-doc-english, kde-frameworks-devel.<br />kossebau requested review of this revision.
</td><a style="text-decoration: none; padding: 4px 8px; margin: 0 8px 8px; float: right; color: #464C5C; font-weight: bold; border-radius: 3px; background-color: #F7F7F9; background-image: linear-gradient(to bottom,#fff,#f1f0f1); display: inline-block; border: 1px solid rgba(71,87,120,.2);" href="https://phabricator.kde.org/D26602">View Revision</a></tr></table><br /><div><strong>REVISION SUMMARY</strong><div><p>Currently kapidox uses the macro DOXYGEN_SHOULD_SKIP_THIS to enable code<br />
it processes to control what doxygen sees. That macro, while taken from<br />
the example given in the official doxygen documentation,<br />
( <a href="http://www.doxygen.nl/manual/faq.html#faq_code" class="remarkup-link" target="_blank" rel="noreferrer">http://www.doxygen.nl/manual/faq.html#faq_code</a> ) has some disadvantages:</p>

<ul class="remarkup-list">
<li class="remarkup-list-item">it is not a macro officially set by doxygen</li>
<li class="remarkup-list-item">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</li>
</ul>

<p>Example:<br />
#ifdef DOXYGEN_SHOULD_SKIP_THIS<br />
// will this code be processed by kapidox/doxygen? Yes, it will<br />
#endif</p>

<p>Using a K_DOXYGEN macro definition instead follows an existing pattern<br />
known from code checking the (compiler) tool being processed by, like<br />
<u>GNUC</u>, <u>clang</u> or Q_QDOC.</p></div></div><br /><div><strong>REPOSITORY</strong><div><div>R264 KApiDox</div></div></div><br /><div><strong>BRANCH</strong><div><div>introduceK_DOXYGEN</div></div></div><br /><div><strong>REVISION DETAIL</strong><div><a href="https://phabricator.kde.org/D26602">https://phabricator.kde.org/D26602</a></div></div><br /><div><strong>AFFECTED FILES</strong><div><div>README.md<br />
src/kapidox/data/Doxyfile.global</div></div></div><br /><div><strong>To: </strong>kossebau, Frameworks<br /><strong>Cc: </strong>kde-frameworks-devel, kde-doc-english, LeGast00n, gennad, fbampaloukas, GB_2, michaelh, ngraham, bruns, skadinna<br /></div>