Sign in Join

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

Mailing lists / fpc-pascal / 2010-06

Documentation differences...

6 messages · 4 people ·

Reply by email Subscribe to this list Your subscription

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

Torsten Bonde Christiansen

Hi List.

I have been wondering for some time now what the difference is between the source documentation (online versions) on the pascal website (http://www.freepascal.org/docs-html/rtl/) and the one placed on the Lazarus CCR website (http://lazarus-ccr.sourceforge.net/docs/rtl/) - this goes not just for the RTL, but also FCL.

Sometime i can find information regarding some classes in one but not the other, and at othertime it's the other way around.

Perhaps I've overlook something, but I can't seem to find any logic in which is the most updated and why some things exist one place and not the other.

Kind regards,
Torsten Bonde Christiansen.

Reply by email

Michael Van Canneyt
to Torsten Bonde Christiansen
Torsten Bonde Christiansen wrote 13 lines
Hi List. I have been wondering for some time now what the difference is between the source documentation (online versions) on the pascal website (http://www.freepascal.org/docs-html/rtl/) and the one placed on the Lazarus CCR website (http://lazarus-ccr.sourceforge.net/docs/rtl/) - this goes not just for the RTL, but also FCL. Sometime i can find information regarding some classes in one but not the other, and at othertime it's the other way around. Perhaps I've overlook something, but I can't seem to find any logic in which is the most updated and why some things exist one place and not the other.

Well,

http://www.freepascal.org/docs-html/rtl/

is the official documentation. Normally, it is updated only when a new version of the compiler is released. That's all I can say about it.

Michael.

Reply by email

Graeme Geldenhuys
to Torsten Bonde Christiansen: Hi List. I have been wondering for some time now what the difference is between the…

Op 2010-06-23 10:15, Torsten Bonde Christiansen het geskryf:

The official FPC documentation is:

FPC does not show "skeleton" or partial documented units in it's documentation. It is all or nothing.

As far as I know the following is true (please correct me if I am wrong). The Lazarus team thinks that "skeleton" (empty) or partial documentation is still handy, so they decided to build their own online documentation, but includes all units from RTL, FCL, LCL etc... This is what I heard years ago, but I don't know if this is still true. I'm also not sure what versions of FPC units does the Lazarus team use for there online docs (latest release version or Trunk)

Regards,
- Graeme -

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

Reply by email

Torsten Bonde Christiansen
to Graeme Geldenhuys
Graeme Geldenhuys wrote 22 lines
Op 2010-06-23 10:15, Torsten Bonde Christiansen het geskryf: The official FPC documentation is: > (http://www.freepascal.org/docs-html/rtl/) > FPC does not show "skeleton" or partial documented units in it's documentation. It is all or nothing. > (http://lazarus-ccr.sourceforge.net/docs/rtl/) > As far as I know the following is true (please correct me if I am wrong). The Lazarus team thinks that "skeleton" (empty) or partial documentation is still handy, so they decided to build their own online documentation, but includes all units from RTL, FCL, LCL etc... This is what I heard years ago, but I don't know if this is still true. I'm also not sure what versions of FPC units does the Lazarus team use for there online docs (latest release version or Trunk)

From what i can see Lazarus (trunk version) does by default open the Lazarus CCR version of the documentation file, this was my main reason for asking on the list since TComponent does not exists in the CCR version.

Regards,
Torsten Bonde Christiansen.

Reply by email

Graeme Geldenhuys
to Torsten Bonde Christiansen
Torsten Bonde Christiansen wrote
From what i can see Lazarus (trunk version) does by default open the Lazarus CCR version of the documentation file, this was my main reason for asking on the list since TComponent does not exists in the CCR version.

Ah, it seems Lazarus is using the broken 'fpdoc' to generate the online help. fpdoc recently fails to generate docs for most units because of various changes in the source parses (fcl-passrc) that it uses. I had the same problem generating tiOPF and fpGUI docs two or so weeks ago.

I think Michael fixed the problem (fpdoc now only parses Interfaces section) recently in Trunk - not sure if that fix made it into 2.4.2 release coming out soon (lets hope it does).

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

Reply by email

Marco van de Voort
to Graeme Geldenhuys

In our previous episode, Graeme Geldenhuys said:

Show quoted text 9 lines
Ah, it seems Lazarus is using the broken 'fpdoc' to generate the online help. fpdoc recently fails to generate docs for most units because of various changes in the source parses (fcl-passrc) that it uses. I had the same problem generating tiOPF and fpGUI docs two or so weeks ago. I think Michael fixed the problem (fpdoc now only parses Interfaces section) recently in Trunk - not sure if that fix made it into 2.4.2 release coming out soon (lets hope it does).

I've received no request of Michael to merge that.

Reply by email