GeezerVison is showing pasdoc.github.io — Configuration file for command-line options
Configuration file for command-line options
Overview
Use special @<path-to-file> CommandLine option to make pasdoc read options from file. This is similar to how FPC allows specifying config files.
pasdoc @my-config-file.txt myuni1.pas
Details
-
There could be any number of @<path-to-file> options and they could be freely mixed with other options thus allowing flexible customization. The rule is simple: every @<path-to-file> option is replaced by the contents of the file.
-
Config file must contain one option per line. Examples are below.
-
Format is name[=value] where
-
name is a long option name just like in the command line but without leading dashes (short names are not accepted, to force the file to be more readable).
-
value is an option value (if an option requires it). Do not "quote" values with spaces (we do not recognize apostrophe or double-quote as a special character in the config file, it would instead be included within the value).
-
Option values inside config file can contain macros that are replaced with actual values. Currently we only support one macro:
Examples
Examples of config file contents.
Correct
markdown
auto-link
title=My super project
include=$CFG_PATH/includes/
Not correct
no-macro auto-link // two options per line
--markdown // leading dashes
title="My super project" // value is quoted. Quotes will be considered as a part of the title
output html // no `=` character between name and value
D=MSWINDOWS // only long option names allowed
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:
|