On 3-10-2011 9:58, Jon Cruz wrote:
Hi,
I've gotten back to trying to get more documentation straightened out and filled out. Some architechtural overview, getting started type details, etc.
Does anyone else want to lend a hand? :-)
Or more importantly are there any specifics I should look into filling out? That is, any areas people want me to look into, or any aspects that need special attention, etc.
What would help me a lot is a set of examples/templates on the wiki that I can cut and paste into the source and modify. What I am looking for in doc templates is ways to document: - a class - a method within a class - a C function - a method with arguments, specifying what each argument means - a method that returns something, specifying what is returned - exceptions that function may throw - how to refer to another class, method, or argument.
(this should just be a couple big fully featured templates)
Every time I want to document something, I end up searching the code base and the web for a long time to find out how to do 'standard' things...
Thanks a bunch, Johan