[kplato] Writing APIDox proposal
Raphael Langerhorst
raphael.langerhorst at kdemail.net
Wed Mar 29 17:31:38 CEST 2006
Am Mittwoch, 29. März 2006 16:58 schrieb Galmes Pierre-Andre:
> Hello,
>
> I have been following the Kplato development since some month and would
> like to start helping. I already have knowledge on development (Subversion,
> C++, some QT...). As I won't have much time I would like to help adding
> some APIDOX to the Kplato Sources (adding comments to the code). I do not
> promise I will do something, but I will try !
>
> Are there some parts of the source needing some APIDOX ? Which are the
> important parts ? Do you already have some external documentation on how
> the code is organized ? Is there something else you think I could help on
> wth little time ?
>
> Regards,
Hi Pierre-André,
thanks for your willingness to help with docs. That's always a pleasure for
me :)
I would suggest you just start anywhere you want and expand your understanding
of the source from there and document the classes after understanding them.
Regarding external documentation... I plan to work on such a developer
handbook (or whatever you want to call it) for a while now. I need to find
the proper time to start on it though - and not everyone is convinced that we
really need one. But I think it's good to have a document that outlines the
design of KOffice as a whole and the individual components, at least in a
general way so that new developers/contributors find their way into the
project faster and easier.
If you start with APIDOX that's great.
Thanks,
Raphael
More information about the kplato
mailing list