<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<p>So I tried adding some new comments and noticed they didn't
appear in the doxygen output. In fact I noticed may classes are
missing.</p>
<p>After a bit of digging it seems that doxygen doesn't like the
Q_DECL_HIDDEN macro. So I've added these lines to Doxyfile</p>
<p><tt>MACRO_EXPANSION = YES</tt><tt><br>
</tt><tt>EXPAND_ONLY_PREDEF = YES</tt><tt><br>
</tt><tt>PREDEFINED = Q_DECL_HIDDEN= \</tt><tt><br>
</tt><tt> Q_OBJECT=</tt><tt><br>
</tt></p>
<p>This strips out these macros from the doxygen preprocessor.</p>
<p>I also added these, as I think the output is useful.<br>
</p>
<p><tt>SHOW_USED_FILES = YES</tt><tt><br>
</tt><tt>SHOW_FILES = YES</tt></p>
<p>And finally I updated the overall config file to a more recent
one. A lot of comments changed, so the commit is a bit noisy,
sorry.</p>
<p>I hope this is acceptable.</p>
<p>A merge request has been sent, which also includes some minor
Mainpage.dox fixes.<br>
</p>
<p>Thanks.<br>
</p>
<pre class="moz-signature" cols="72">--
David</pre>
<div class="moz-cite-prefix">On 05/01/2021 16:47, Gilles Caulier
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CAHFG6sH_K71-H+O8Ofaq=SBHEgkMxJMaCyyVbF1cNBfYmr6vWA@mail.gmail.com">
<pre class="moz-quote-pre" wrap="">Hi and happy new year.
All pull requests are welcome of course, especially brief descriptions
of classes.
Doxygen comment in digiKam use /** ... */
For inline comment, we use ///< ...
Best regards
Gilles Caulier
Le mar. 5 janv. 2021 à 17:43, David Haslam <a class="moz-txt-link-rfc2396E" href="mailto:dch.code@gmail.com"><dch.code@gmail.com></a> a écrit :
</pre>
<blockquote type="cite">
<pre class="moz-quote-pre" wrap="">
When I submit fixes, is it acceptable to also add new doxygen comments? In particular, I'd like to at least add \brief class descriptions where I've worked out what something does.
Also, is there any preference for the comment style: /**, ///, /*!, //!
--
David
</pre>
</blockquote>
</blockquote>
</body>
</html>