Next: , Previous: Annotations, Up: Documenting Your Code


3.14 Topics

If you want to include with your documentation pages that are not related to a Pascal identifier, you must use a Topic header. You can insert a Topic in a Package or in a Module. A Topic has a name, a short description and a long description. If a Topic appears in a Package it can also have Sub Topics after his long description.

     Example: Topic example  
      1  Topic: UsingKeyboard -- Using the keyboard functions
      2
      3  To use the keyboard functions of the CRT unit, one...
      4
      5  Sub Topic: UsingShiftKey -- Using the shift key
      6
      7  ...