Sign in Join

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

Mailing lists / fpc-pascal / 2012-07

Should FCL documentation be splitted?

6 messages · 3 people · –

Reply by email Subscribe to this list Your subscription

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

leledumbo

I would like to document some of the FCL, however the layout is still like the first time it appears in FPC. Current FCL are splitted into many subpackages, and since the number of units is HUGE (which I guess the same reason why the package was splitted) would it be better to split the documentation as well?

View this message in context: http://free-pascal-general.1045716.n5.nabble.com/Should-FCL-documentation-be-splitted-tp5710248.html Sent from the Free Pascal - General mailing list .

Reply by email

Unknown author
to leledumbo
leledumbo wrote 5 lines
I would like to document some of the FCL, however the layout is still like the first time it appears in FPC. Current FCL are splitted into many subpackages, and since the number of units is HUGE (which I guess the same reason why the package was splitted) would it be better to split the documentation as well?

No, it's better to keep it together:
1. to have an overview of what is available.
2. cross-referencing across packages in documentation is not easy.

Michael.

Reply by email