[fpc-devel] Documentation questions

[Michael Van Canneyt]

On Thu, 10 May 2007, Felipe Monteiro de Carvalho wrote:

> Hallo,
> 
> I will be writing some rtl units for Symbian OS, and I think they will
> require some documentation, specially because the use of some
> functions vary a lot from the c++ API. How would I procede? (I don´t
> know where to start). Is the basic structure generated automatically?

if you want to generate reference documentation, the procedure is

makeskel --package=rtl --input='symbian.pp' --output=symbian.xml 
edit symbian.xml
fpdoc --format=html --package=rtl --input='symbian.pp' --descr=symbian.xml 

(the options are all documented)

> 
> I am thinking of some units, like:
> 
> symbian - Procedural bindings for generic symbian
> symbianclasses - object-oriented bindings for generic symbian
> uiq - procedural bindings for uiq specific units
> uiqclasses - oo bindings for uiq specific units
> 
> I´m not yet sure how to deal with the different symbian/uiq versions
> ... maybe IFDEFs will be enougth.
> 
> Also, it would be wonderful if docs for FCL are generated =) Even if
> just an empty skeleton, and put on the web, to get an overview of fcl
> and see where things are located, and how they are declared.

Currently docs for 20 FCL units are generated, and the number is growing.

I do not put empty docs on the web, that's a matter of policy. Either
the unit is documented completely, or it's not documented at all.

Michael.