GeezerVison is showing pasdoc.github.io — Advanced Features
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 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.
Features:
-
@abstract
-
@author
-
@bold, @italic
-
@br
-
@code
-
@created, @lastmod
-
@cvs
-
@deprecated
-
@exclude
-
@html
-
@image
-
@includeCode
-
@include
-
@name, @className, @inheritedClass, @inherited
-
@shortTitle, @title, @section, @anchor
-
@latex
-
@link
-
@orderedList, @unorderedList, @definitionList, @item, @itemLabel, @itemSpacing, @itemSetNumber
-
@longCode
-
@member, @value
-
@noAutoLink, @noAutoLinkHere
-
@note, @warning
-
@param, @returns, @raises
-
@preformatted
-
@seeAlso
-
@tableOfContents
-
@table, @row, @rowHead, @cell
-
@nil, @true, @false
-
@(, @)
-
@url
-
Examples
- --format:
-
--auto-abstract
-
--auto-back-comments
-
--auto-link, --auto-link-exclude
-
--cache
-
--marker, --staronly, --marker-optional
-
--define, --conditionals
-
--css, --css-based-on-bootstrap
-
--title
-
--exclude-generator
-
--external-class-hierarchy
-
--graphviz-uses, --graphviz-classes, --link-gv-uses, --link-gv-classes
-
--header, --footer
-
--html-head, --html-body-begin, --html-body-end
-
--ignore-leading
-
--ignore-marker
-
--inherited-members
-
--introduction, --conclusion, -A, --additional
-
--implicit-visibility
-
--lowercase-keywords
-
--visible-members
-
--include-creation-time
-
--include
-
--link-look
-
--markdown
-
--name
-
--no-auto-abstract
-
--no-macro
-
--language
-
--output
-
--description
-
--show-source-position, --source-url-pattern, --source-root
-
--sort
-
--spell-check, --spell-check-ignore-words
-
--use-tipue-search
-
--write-uses-list
-
@<config-file.txt>
- --implementation-comments
Development:
|