Re: [Usbpicprog-technical] Using doxygen to document internal functions

[Francesco M. <f18...@ya...>]

Hi Frans,

Frans Schreuder ha scritto:
> I think Doxygen is a good idea, the thing is that I have never done it, 
> how do I start?
I've just committed the necessary setup to generate the manual.

To generate it (it's a good thing to NOT commit to SVN repo the HTML files 
generated by doxygen), just cd to upp_wx/docs and run "doxygen", then "firefox 
html/index.html".

To use doxygen you just need to write the comments in the headers with a special 
syntax.
E.g. instead of /* */ if you want that comment to document the function that 
follows it, just must use /** */.
Instead of // use /// or //!

More info at: http://www.stack.nl/~dimitri/doxygen/docblocks.html

Bye,
Francesco


PS: I've not committed doxyfied comments for PicType since I'm modifying it for 
the XML-data load stuff (see the other mail).

--