Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-devel / 2008-10

FPC's documentation

5 messages · 4 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

ik

Hello,

It seems that many unit of RTL, packages etc.. does not contain proper documentation or there an attempt to create such documentation, or any plans to create a work type that on every feature/new support it will be marked as "done" only when there is also a documentation about it ?

The reason I'm asking is, because I'm finding myself helping a lot of people over here (I'm working really hard to make people to try FPC), and the common problem for all is this issue.

Thanks,

Ido

Reply by email

Graeme Geldenhuys
to ik
ik wrote 6 lines
It seems that many unit of RTL, packages etc.. does not contain proper documentation or documentation at all. Is there an attempt to create such documentation, or any plans to create a work type that on every feature/new support it will be marked as "done" only when there is also a documentation about it ?

Michael van Canneyt has been doing an awesome job documenting FPC. He has written all the docs (fpdoc and pdf books) with very little contributions as far as I understand. I'm sure he will appreciate any contributions to units he has not documented yet. ;-)

Also note that unlike Lazarus, the online help for FPC doesn't show "skeleton" documentation. If the unit has not been fully documented, it doesn't appear in the online version.

Regards,
- Graeme -

_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

Reply by email

Michael Van Canneyt
to ik: It seems that many unit of RTL, packages etc.. does not contain proper documentation or …
ik wrote 11 lines
Hello, It seems that many unit of RTL, packages etc.. does not contain proper documentation or documentation at all. Is there an attempt to create such documentation, or any plans to create a work type that on every feature/new support it will be marked as "done" only when there is also a documentation about it ? The reason I'm asking is, because I'm finding myself helping a lot of people over here (I'm working really hard to make people to try FPC), and the common problem for all is this issue.

Well, my guess is that at the current speed, all will be documented somewhere around 15 may 3012, give or take a week.

If we had a team of 15 full time writers, maybe 20 october 2012 would be feasible.

Of course, this is all assuming everybody stops producing code right now.

And knowing the enthusiasm of some of my fellow developers (or indeed myself), that will be hard to achieve.

The FPC distribution contains about 9,900 files, with 3,141,555 lines of code. Not something to document when bored on a rainy sunday afternoon.

Michael.

Reply by email

Lukas Gradl
to Michael Van Canneyt
Well, my guess is that at the current speed, all will be documented somewhere around 15 may 3012, give or take a week.

Is that a promise? Made a note on my calendar for that date....

If we had a team of 15 full time writers, maybe 20 october 2012 would be feasible.

Oh - there are less than 15 full time writers that earn a fortune each? Didn't know that...

*bg*
Lukas

-------------------------- software security networks Lukas Gradl <fpc#ssn.at> Eduard-Bodem-Gasse 9 A - 6020 Innsbruck Tel: +43-512-214040-0 Fax: +43-512-214040-21 --------------------------

Reply by email

Graeme Geldenhuys
to Lukas Gradl
Lukas Gradl wrote
Oh - there are less than 15 full time writers that earn a fortune each? Didn't know that...

The core FPC team is quite small (excluding people that give minor contributions). It's something like 6-8 people if I remember correctly. That impressed me even more, considering how great FPC is and the size of the team.

Regards,
- Graeme -

_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

Reply by email