Damien Duportal wrote:
Ih all.
I've begun to write a page in the wiki to explain salframe functionnement.
I need a little bit of help because i'm very newbie in C++, so i've to
take my time to understand, and i'm not very well with english...
The page : http://wiki.services.openoffice.org/wiki/
Mac_OS_X_Porting_salframe
Thanks to all critics, addings (or removes) and any commentaries are
welcome.
Don't left the main purpose : documentate for all kind of developers :
newbie as me, hard coders in C++ or another languages, but new to OOo
structur, testers, curious etc...
In my advise, i could begin some works since one month if this have
been done. We don't have so much time, but it's really usefull and
should help news devs...
Don't hesitate to comment !!!
I welcome your laudable effort to provide more and better documentation
for vcl in particular. However what about putting the documentation
you've already started inside the actual header/source files? This is
the place where it belongs when it comes to interfaces, implementation
and other kind of more lower level descriptions.
Sorry but a wiki page is the wrong place for that purpose. :(
I need this documentation when I work on the source code and I probably
need to update it in the course of making changes to the actual sources.
The closer code and documentation are together the higher changes that
the documentation stays up-to-date! OTOH when somebody starts working on
the code he might not even know that there is a wiki page somewhere in
the cyberspace documenting the part he is looking at right now.
For high level design descriptions (e.g. diagrams and other kind of
documentation artifacts) a wiki page might be the appropriate place.
Just my two cents,
Tino
--
It is not the strongest of the species that survive, nor the most
intelligent, but the one most responsive to change.
Charles Darwin
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
