SWI-Prolog Source Documentation Version 2
AllApplicationManualNameSummaryHelp

  • Documentation
    • Reference manual
    • Packages
      • SWI-Prolog Source Documentation Version 2
        • Introduction
        • Overview
        • Structured comments
        • File (module) comments
        • Type, mode and determinism declaration headers
        • Tags: @see, etc.
        • Wiki notation
        • Directory indices
        • Documentation files
        • Running the documentation system
        • Motivation of choices
        • Compatibility and standards

8 Directory indices

A directory index consists of the contents of the file README (or README.TXT), followed by a table holding all currently loaded source-files that appear below the given directory (i.e. traversal is recursive) and for each file a list of public predicates and their descriptive summary. Finally, if a file TODO or TODO.TXT exists, its content is added at the end of the directory index.