Quick! Someone relegate him to management!<div><br></div><div>Mark<br><br><div class="gmail_quote">On Tue, Mar 5, 2013 at 10:11 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:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On 2013-03-05 20:01, Teemu Murtola wrote:<br>
</div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">
Hi,<br>
<br>
<br>
On Tue, Mar 5, 2013 at 5:23 PM, David van der Spoel<br></div><div><div class="h5">
<<a href="mailto:spoel@xray.bmc.uu.se" target="_blank">spoel@xray.bmc.uu.se</a> <mailto:<a href="mailto:spoel@xray.bmc.uu.se" target="_blank">spoel@xray.bmc.uu.se</a>>> wrote:<br>
<br>
how can I get doxygen to pick up comments on methods, classes,<br>
namespaces etc.? Is it sufficient to have the proper comments in<br>
random files for doxygen to pick it up? Or do I need to add<br>
filenames/directory names to some input script?<br>
<br>
<br>
Assuming you are on the master branch (or somewhere derived from it),<br>
you don't need to do anything special for Doxygen to consider your file.<br>
Everything under src/ is recursively included. Some files/directories<br>
are excluded (the list is in doxygen/Doxyfile-common.<u></u>cmakein), but that<br>
should not normally affect you. If your comments don't seem to appear in<br>
the output, then there may be issues with the enclosing scope<br>
(file/namespace/class) not being properly documented. This is mentioned<br>
at <a href="http://www.gromacs.org/Developer_Zone/Programming_Guide/Doxygen" target="_blank">http://www.gromacs.org/<u></u>Developer_Zone/Programming_<u></u>Guide/Doxygen</a>,<br>
along with a lot of other stuff related to Doxygen, but I don't know all<br>
the rules without more thorough testing.<br>
<br>
Teemu<br>
<br>
<br>
</div></div></blockquote>
Thanks! Indeed that works, just had to add more comments to the files.<br>
<br>
I can highly recommend adding those doxygen comments, the reward in terms of the documentation is amazing. All of a sudden I understand my own code!<div class="HOEnZb"><div class="h5"><br>
<br>
-- <br>
David van der Spoel, Ph.D., Professor of Biology<br>
Dept. of Cell & Molec. Biol., Uppsala University.<br>
Box 596, 75124 Uppsala, Sweden. Phone: <a href="tel:%2B46184714205" value="+46184714205" target="_blank">+46184714205</a>.<br>
<a href="mailto:spoel@xray.bmc.uu.se" target="_blank">spoel@xray.bmc.uu.se</a> <a href="http://folding.bmc.uu.se" target="_blank">http://folding.bmc.uu.se</a><br>
-- <br>
gmx-developers mailing list<br>
<a href="mailto:gmx-developers@gromacs.org" target="_blank">gmx-developers@gromacs.org</a><br>
<a href="http://lists.gromacs.org/mailman/listinfo/gmx-developers" target="_blank">http://lists.gromacs.org/<u></u>mailman/listinfo/gmx-<u></u>developers</a><br>
Please don't post (un)subscribe requests to the list. Use the www interface or send it to <a href="mailto:gmx-developers-request@gromacs.org" target="_blank">gmx-developers-request@<u></u>gromacs.org</a>.<br>
</div></div></blockquote></div><br></div>