[fpc-pascal] Documentation, syntax diagrams

Jürgen Hestermann juergen.hestermann at gmx.de
Thu Jan 9 17:53:08 CET 2014


Am 2014-01-09 08:26, schrieb Michael Van Canneyt:
 >> That what should be declared is repeated in the declaration
 >> itself which makes no sense to me.
 >> A syntax diagram for 'type declaration' (which is written in the heading already)
 > The heading is a caption.
 > In typesetting, normally that is not considered part of the diagram itself,
 > just like a table or figure caption is not considered part of the table or figure.

But why is the heading part of the diagram?
It should be just that: A heading (in an extra line before the diagram).
For example on page 29:


String Type
----- string type -- STRING --|--------------------------------|----
                               \-- [ -- unsigned integer -- ] --/

There is already the heading "String Type",
then - as part of the diagram (surrounded by lines) - "string type" appears again!
Why?
That's totally confusing.
It should be like this:

String Type:
----- STRING ----|--------------------------------|----
                  \-- [ -- unsigned integer -- ] --/

or

String Type =
----- STRING ----|--------------------------------|----
                  \-- [ -- unsigned integer -- ] --/




More information about the fpc-pascal mailing list