Advanced Features

Table of Contents

Some important non-obvious PasDoc features:

1. Input

  • We automatically treat the 1st sentence of the description as an abstract. So make sure it "stands on its own" and is a good short description of the item. You can also explicitly specify the abstract using @abstract tag.

  • You can write entire pages using pasdoc syntax, with all supported @tags. This way you can use pasdoc like a simple document creation tool. See the Introduction and conclusion documentation.

  • By default documentation is read from the source code comments. But you can also write it in separate external files: see the --description command-line option.

  • By default we consider only comments in the interface section of the unit. But you can enable parsing also the implementation sections, and using comments from it, using the --implementation-comments option.

  • By default every comment before an identifier is treated as a documentation. But you can limit this with arbitrary comment markers.

  • --auto-link command-line option allows you to avoid writing so many @link tags. Identifiers will be automatically turned into links.

  • Markdown support for emphasis, lists, code blocks etc.

2. Output