[gmx-developers] has in-body comments, which are ignored

Teemu Murtola teemu.murtola at gmail.com
Wed Sep 2 16:03:17 CEST 2015

No, this message comes from check-source, which is our own style (and
other) checker. In-body refers to the body of the function, and I think
this is the term used also in doxygen configuration. If there are no
doxygen-formatted comments (e.g., starting with /** or ///), then something
is tricking doxygen parser to see such things (or there can be a bug in the
checker, but I'd first see what doxygen actually thinks is in the file).

You can run the doxygen-xml target locally and check the xml files to see
what it thinks is an in-body comment, or you can add some debug prints to
the docs/doxygen/check-source.py.


On Wed, Sep 2, 2015, 15:27 Mark Abraham <mark.j.abraham at gmail.com> wrote:


I think the message is confusing ("in body" refers to the body of the
file?), but is caused by the fact that there is no file-level Doxygen
markup in tpi.cpp, so Doxygen has nowhere to put the docs. I suggest
adapting e.g. that of mdrun_signalling.cpp


On Wed, Sep 2, 2015 at 10:33 AM David van der Spoel <spoel at xray.bmc.uu.se>


I'm stuck with a doxygen problem
has in-body comments, which are ignored

the source file/routine in question does have normal comments /* bla bla
*/ but that should be fine, right?

The problem appeared after I moved a function into the gmx namespace.
This is the affected patch

Any clues how to work around it?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://maillist.sys.kth.se/pipermail/gromacs.org_gmx-developers/attachments/20150902/389f1010/attachment.html>

More information about the gromacs.org_gmx-developers mailing list