[Gajim-devel] Gajim API docs [and thoughts on coding standards and testing]

[Yann Leboulanger]

replying to the list

Mateusz Biliński wrote:
> On Fri, May 30, 2008 at 5:02 PM, Yann Le Boulanger <asterix at lagaule.org> wrote:

>> Yes please, it's really easier when coding in console.
> 
> OK. So I'll stick to it :)
> 
>> I haven't looked at that code yet, but having common code for all test
>> program sounds a must.
> 
> OK. I'll just write my tests separately and we'll figure out 'common
> parts' later.
> 
>> Great, I'll add that to website !
> 
> Generally, we could add 'epydoc.conf' to trunk, so that users could
> easily generate apidocs on their own.
> 
> I've also thought of putting 'epydoc ---conf=epydoc.conf' to CRON on
> gajim.org server (once a day?), so that we have up-to-date API docs
> on-line. I can do it on my server - no problem, but gajim.org domain
> seems more appropriate :)

Yep it's what I thought to do: a cron job.

>>> Summarizing, the questions is: how should I document my code? :)
>> I would vote for epydoc syntax. If we really need doxygen one day it seems
>> easy to switch to javadoc.
> 
> OK. So I'll use epytext syntax. :) Switching to Javadoc later seems to
> be rather 'automatic'.
> 

nice, and we should all do the same from now
-- 
Yann