Dirk Meyer wrote:
> Jason Tackaberry wrote:
>> On Sat, 2008-10-18 at 11:56 +0200, Dirk Meyer wrote:
>>> The complete doc from http://www.sachmittel.de/kaa/ should be available
>>> at http://doc.freevo.org/kaa in the future. And from time to time we can
>>> update the doc with scp.
>>
>> Why not generate the docs directly on the web server via a cron job?  Or
>> we could be sophisticated and regenerate docs based on svn hooks :)
>
> Hooks may not be a good idea because it would delay check in. But cron
> sounds nice.

BTW, I also made a doc for kaa.imlib2 (also on my website). While doing
the docs I removed some @param (now :param) and put the description in
the text. IMHO it looks better that way and you can skip paramater that
need no explaination. The same is true for @returns. In most cases the
text also describe the return (e.g. get functions). And python.org also
uses this style :)


Dischi

-- 
C.O.B.O.L - Completely Obsolete Boring Old Language.

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Freevo-devel mailing list
Freevo-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/freevo-devel

Reply via email to