On Mar 23, 2011, at 12:07 AM, Andrew wrote:
On 22/03/11 21:04, Johan Engelen wrote:
-----Original Message----- From: Jon Cruz [mailto:jon@...18...] Sent: maandag 21 maart 2011 4:56
First of all, is anyone using our doxygen docs, or does anyone care about the format?
Yes, I care about doxygen, and a little bit about the format. In any case, I think the 'standard' of how to write documentation should be clear to someone who starts writing documentation. For me, it is always a struggle to find a good example in Inkscape's code of how it should be done. For example, how to document a function, specifying what the arguments mean, and what is returned.
I agree, currently I am doing some quite major work to the OCAL dialog code, and it would be helpful if there was a page on the wiki (if it doesn't already exist) with a good example of how to format the comments etc.
Yes. Hopefully I'll be able to get that together. Some start might be good if anyone wants to jump in and just stub some things out.
* start with "/**" * have the first sentence as a brief description, and be sure to end with a period '.' * comment a function/method in the .h and not the .cpp (if it is in both) ...