Hi *,

in the wake of the spec discussion thread, people mentioned that
they'd like to write down hard-won understanding of the code & how
things work somewhere. IMO the best place for nitty-gritty details and
(self)justification why things are as they are is the code itself -
most easy (and thus most likely) to keep stuff in sync there.

I've therefore created CWS codecomments01, so everyone feeling the
urge to improve code comments is welcome to commit there/dump me your
patches (the former much preferred, of course ;-)).

If at all possible, please provide your class/method commentary in
autodoc/doxygen compatible format:
http://tools.openoffice.org/autodoc/HowToWriteDocumentation-Cpp.html

Other places where (possibly more high-level) code explanation might
get: 

http://wiki.services.openoffice.org/wiki/Source_code_directories
(link your module descriptions from there)

http://wiki.services.openoffice.org/wiki/User:Ericb#Sort_of_documentation_about_VCL_around_Native_Mac_OS_X_port
(might benefit from separation etc. but much appreciated)

Cheers,

-- Thorsten

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to