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?

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.

thanks,

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)

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 .

Hallo,

Michael Van Canneyt wrote

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 you sure this is a good policy with the specific case of fcl?

At least to me, docs, even if empty, about fcl would be usefull.

And consider that we already have fcl docs only here:

http://www.freepascal.org/docs-html/fcl/index.html

But those don´t seam to be updated on the last 10 years

So, I would like to ask that docs are put on-line, even if there is no link from the website to them.

thank you for your attention,

Felipe Monteiro de Carvalho wrote

So, I would like to ask that docs are put on-line, even if there is no link from the website to them.

If Michael doesn't want to budge with his documentation policy, I will be more that willing to generate the docs on a weekly or monthly cycle and host them on my server.

I agree with you Felipe. Sometimes it is nice to navigate the docs (even skeleton docs) to find out how class relationships work, etc...

Better take a look at http://lazarus-ccr.sourceforge.net/docs/fcl/

They show only documented units from Michael, but includes the updates since fpc 2.0.4.

Vincent

Even this weekends' updates to the docs are there.

I didn't have the time yet to upload a new version to Idefix. I'm currently documenting the Blowfish unit and will then upload a new version.

Michael.

I don't see what the difference is between RTL and FCL in this regard.

I'd rather see that Graeme does it, if he is prepared to do so.

I can see why you want it, but I do not have time to maintain such a thing.

Michael.