[fpc-pascal] Questions on Documentation

[Michael Van Canneyt]

On Mon, 10 Oct 2005, Bob Richards wrote:

> Hi All:
>
> I am new to this list, but not new to pascal programming. I have been writing pascal code
> since Turbo pascal Version 3.0.
>
> I have installed Free Pascal Ver. 2.0.0, running it on a Linux WorkStation, and am writing
> CGI apps which run on a Linux server. I love FPC! It keeps me honest, and my code "safe",
> and easy to follow years later.
>
> I miss the old DOS IDE of Borland-of-Old; FP is somewhat OK, and Lazarus is way too much
> for system programming. But that's no real problem, VI does me just fine!
>
> The biggest problem I have run into is the function/procedure documentation. While very
> complete, and clearly written, it is organized in a way making it difficult to find
> things. Similar functions and procedures are scattered among various Units, making things
> difficult to locate.

They are per unit, and then alphabetically. This is organized as logical as it
comes.

A unit with a lot of procedures contains topics which group the
procedures by category.

> What I need is a reference document, listing procedures and functions
> by category (or at the very least alphabetically as in the Turbo Pascal 5.0 Reference
> guide). All disk-file routines for instance, listed, in one place.

They are listed like that, but on a unit-per-unit basis. 
You are supposed to know which units you want to use. It makes no sense
to use e.g. SysUtils and Dos.

> I was reviewing some code I wrote, and discovered that some functions I had written were
> now part of an FPC Unit (more elegantly coded I might add).... Is there such a
> cross-reference document somewhere? If not, can one be generated using 'fpcdoc'?

No.

> Are there any printed manuals? Has someone written a good book which would be a good
> reference? Not knowing any OOP (nor having a desire to) would purchasing a book on Delphi
> help me in my FPC documentation quest? Any sugestions on which one?

A book on Delphi will only help you for the OOP part.

Michael.