[Gambas-devel] component documentation

[Benoît Minisini]

Le 01/04/2012 20:13, tobi a écrit :
> hi,
>
> i just wanted to ask if there is any preferred format of documentation for a new component. more
> precisely: how would i document a component so that it may get onto gambasdoc.org easily?
> i looked at most components and none provided any sort of useful documentation...
> (i'm afraid, there is no automatism ;))
>
> regards,
> tobi
>

You should write your documentation entirely inside the wiki.

The wiki generates for you the list of classes in the component page, 
the lists of symbols in a class page, and the syntax in the symbol 
documentation page. Everything is based on the *.info and *.list files 
of the component generated by the gbi3 program.

But nothing prevents you from adding more documentation than just a 
brief description of all methods, properties, constants and events.

Regards,

-- 
Benoît Minisini