Doxygen?

[darktding]

I for one havent explored doxygen, but I know that the odforce guys have made a doxygen page of the houdini sdk.
http://www.odforce.net/wiki/index.php/HDKDoxygenPages
you can try to contact Marc, hes the main html/ forum guru there...

[billrobertson42]

I have used it in the past with great sucess.

You can do a lot with a javadoc/doxygen style of documenting your code. It just takes a little bit of discipline, because if you don't do it while you're updating the code it will never get done, and it could lead to the documentation being inaccurate, which is far worse than just not present.

You also have to use some common sense. i.e. don't waste a lot of time writing "documentation" that just restates the name of the function/method that you're writing. For example, it's kind of pointless to do this...

/**
* Get a buffer.
*/
Buffer* getBuffer();

One really nice feature of Doxygen is that it can also be combined with a graph generating tool (viz I believe) to generate some really useful diagrams automatically. This can be really helpful if you need to figure out what's going on with new code.

[Carina]

I've used doxygen the last year and a half, and I really like it. Dunno what other ones are generally available, doxygen's done everything I've needed to do so haven't really looked elsewhere. It's very easy to use, the documentation generated is nice looking, easily customisable etc.

[Robert Bateman]

yeah doxygen is good. Usage of it is very much recommended.....

[CGTalk Moderation]

This thread has been automatically closed as it remained inactive for 12 months. If you wish to continue the discussion, please create a new thread in the appropriate forum.