On 14/11/06, Jean-Sebastien Delfino <[EMAIL PROTECTED]> wrote:
Pete Robbins wrote: > Definitely! Done under revision r474696. On linux, run configure with the --enable-doxygen option. It's off by default. On Windows run doxygen Doxyfile.w32 from the doc directory. The doc is generated under doc/doxygen. The same scheme can be replicated for SDO. > We did this with the tree originally so some of the code has > comments in the correct Doxygen format. Is there an option to insert > comment > headers into the source? > The doxygen format is described there: http://www.stack.nl/~dimitri/doxygen/docblocks.html. You can write doc blocks anywhere except inside the body of a function. What did you mean by "is there an option to insert comment headers into the source"?
I meant can we get Doxygen to insert the correct format comment block above methods etc. with blank content. I'm sure not all methods have the correct comments! So for a method int fred(string x); we need /** @param x @return **/ int fred(string x); Just a thought! We need to document our code in a consistent way which it isn't at the moment. Cheers, -- Pete
