Advanced Features
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
interfacesection of the unit. But you can enable parsing also theimplementationsections, 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
@linktags. Identifiers will be automatically turned into links.
2. Output
-
Our HTML output has a modern, mobile-friendly design based on Bootstrap. You can customize it using --css or --css-based-on-bootstrap command-line options. You can also add your own HTML code to the output using --html-head, --html-body-begin and --html-body-end command-line options.
-
The documentation of each class can also include inherited members.
-
The documentation of each class can have toggable (using checkboxes in HTML) visibility e.g. for protected members. See --visible-members command-line option.
-
The documentation can point to the source code (file, line number) where given item is declared. It can even link to the online repository (e.g. GitHub) which is a great way to link people from your docs to your code. See the --show-source-position, --source-url-pattern, --source-root command-line options.
-
You can easily add a search box to your documentation, just pass --use-tipue-search command-line option.
-
The documentation can be localized to many languages, see the --language command-line option.
-
GraphVizSupport allows PasDoc to easily incorporate classes inheritance and unit dependency graphs in the documentation.