[gmx-developers] C++ decisions - header file extension - use of bool

Teemu Murtola teemu.murtola at gmail.com
Tue Mar 19 06:21:54 CET 2013

On Mon, Mar 18, 2013 at 11:16 PM, David van der Spoel
<spoel at xray.bmc.uu.se>wrote:

> On 2013-03-18 20:40, Teemu Murtola wrote:
>>   * Doxygen documentation may reference headers by file name, and this
>>     may silently break if the referenced header gets renamed.
>>  Thanks for thinking this through. I guess it may not be worth the effort
> then. I don't understand the doxygen comment though, I thought it picked up
> all files on its way.

You don't need to give up so easily. ;) I still estimate this at only a few
hours of effort; your best bet would probably be writing a few scripts to
rename the include guards and all instances of the basenames of the headers
in the source tree. And searching for wildcards like "*.h" from the source.
For doxygen, it indeed picks up all the files, but I was referring to
possible comments like "See basicoptions.h for the available concrete
classes.", which explicitly mention the name of some file. There isn't that
many of these, as mostly the documentation only references class names, but
there are some.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://maillist.sys.kth.se/pipermail/gromacs.org_gmx-developers/attachments/20130319/6f1e3e91/attachment.html>

More information about the gromacs.org_gmx-developers mailing list