[OGo-Documentation] code documentation

[Sebastian Reitenbach]

Hi,

I raised that topic a long time ago, but in the end, not much came out, as 
it not went into the source tree. So I'll try again raising the topic ;)

I'm going to try to write new development documentations, a bit more high 
level. While doing that, I have to wade through a lot of source files, 
figuring out, how things are working. 
E.g. after get the OGoAddressMapLink using a SkyExternalLink or sth. 
similar, I wanted to add a plone page, how to create and use OGoUIElements.

While doing that, I would add documentation comments to the source files, 
e.g. GSDoc, or doxygen?
Is there any kind of automatic code generation stuff used already, then I'd 
stick to that, if not, are there any preferences?

Well, GSDoc should be fine, as it is designed for GNUstep/Objective-c stuff, 
but e.g. doxygen might have more features,... (ok, don't know whether these 
more features are useful at all for the ogo docs)

If it could be agreed amongst the developers to a documentation system, and 
that automatic code documentation is sth. wanted, and that documentation 
comments in the code will be added to the source tree.

Also I don't think that it is important that the documentation is looking 
nice, and that the documentation system has lots of nifty features, I think 
that the important thing first is, that there is some code documentation at 
all, and it is easily usable.

any thoughts on that?

thanks 
Sebastian