<div dir="ltr">Hi,<div class="gmail_extra"><br><div class="gmail_quote">On Mon, Apr 20, 2015 at 12:20 PM, David van der Spoel <span dir="ltr"><<a href="mailto:spoel@xray.bmc.uu.se" target="_blank">spoel@xray.bmc.uu.se</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">using doxygen brings about a whole new level of debugging.</blockquote><div><br></div><div>Doxygen has its quirks (unfortunately quite many of those), and we have some extra checks to make sure people are not bitten by those quirks (and don't leave solving all the problems for others). Most of the stuff is documented at</div><div> <<a href="http://jenkins.gromacs.org/job/Documentation_Gerrit_Nightly/javadoc/doxygen/html-lib/page_doxygen.xhtml">http://jenkins.gromacs.org/job/Documentation_Gerrit_Nightly/javadoc/doxygen/html-lib/page_doxygen.xhtml</a>></div><div>(should update automatically whenever new documentation is merged from Gerrit, but I'm not sure whether that works currently, as the last build is a month old).</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"> In this case I have in the preamble of my code:<br>
<br>
/*! \internal \file<br>
* \brief<br>
* Declares gmx::EnergyFrame<br>
*<br>
* \author David van der Spoel <<a href="mailto:david.vanderspoel@icm.uu.se" target="_blank">david.vanderspoel@icm.uu.se</a>><br>
* \ingroup module_energyanalysis<br>
*/<br>
<br>
then I got the message in the subject which seems to complain I have *TOO MUCH* documentation, e.g.:<br></blockquote><div> </div><div>For Doxygen, the file-level documentation is very loosely coupled with classes within that file. In particular, whether you document the file or not, classes within that file will still always appear in the documentation if they are documented. So in order to not pollute the documentation for the installed/public headers, we have an extra check that classes from non-installed headers should not be documented as public, since this is very easy to miss otherwise.</div><div><br></div><div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">Any clue how to resolve this?</blockquote><div><br></div><div>You need to use \internal also in the beginning of every class documentation within that file. This is all documented on the page linked above. ;) </div></div><div><br></div><div>Best regards,</div><div>Teemu</div></div></div></div>