Hi,
We will have a lot of work, for a long time in vcl, dtrans and
certainly other modules.
A lot ot comments are missing, or no complete, in vcl (for us) and
generally in OpenOffice.org code. Before we can work, we absolutly must
start completing existing code with comments. Else, none can come to
help us, and define exact tasks is harder.
I was wondering how to efficiency add comments in the code, in order to
generate, using doxygen a quality documentation for developers.
I have two propositions.
The first one :
- create a cws named macosx_code_doc resunchronized very often, where
we directly could push every comment we add.
- use doxygen for documentation generation : this universal tool is
available on every platform
The objectives, with this are :
- easy to update
- easy to complete
- may be read/completed by everyone.
- don't break anything, but is close to the code.
- can be integrated ?
If I remember correctly, Stephan, Tino, Maho, Florian, Christian and me
have rights to commit.
First thing is to define a first set of rules for the comments we will add.
Second possibility :
At work, one of my students has written a tool ( using php/mysql ) to
administrate scheduling of newspaper writing.
This tools can easely be modified to write OpenOffice.org code
documentation, using login, passwords, roles and hierarchy. Using http,
a complete status of tasks ( in % of resolution) can be shown.
This is a complete different solution, interesting too.
- less strict, the content is not code oriented, but http or whatever
format directly.
- tasks are nominatives
- easy to administrate
- deadline can be defined for every tasks
Opinions ?
Regards,
eric bachard
--
<[EMAIL PROTECTED]>
Francophone OpenOffice.org Commmunity developer (Linux PPC / Mac OS X /
X11)
See : <http://fr.openoffice.org>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
