Next: , Up: Documenting Your Code


3.1 Basic Rules

  1. Txt2FPDoc knows nothing about Pascal.

    It just offers an alternative to XML for writing documentation. It does not check that code and documentation are consistent.

  2. Indentation as no meaning.

    The meaning of a line depends only on its first non-blank characters.

  3. Special chars can be escaped by ‘\’.

    Some characters have a special meaning. For examples ‘-’ on the beginning of a line means that the line is an unordered list item. Starting the line by ‘\-’ makes Txt2FPDoc consider this line as simple text. A true ‘\’ can be obtained by ‘\\’.