Description Files

PasDoc can read descriptions from external files specified by the --description (short form -R) option on the CommandLine.

Example:

pasdoc --description my_descriptions.txt unit1.pas

The description file must have the following format:

#Item1
The multi-line description
for item1 goes here.
#Item2
The description for item2 goes here.

ItemN should uniquely identity the item you want to describe. It is safest to use a fully qualified name, including the unit name, like UnitName.ProcedureName or UnitName.TClassName.MethodName. But you can also omit the UnitName. qualifier, if you don’t worry about duplicate identifier names in multiple units.

Example:

#UnitMyClass.TMyClass
This is the description of TMyClass in unit UnitMyClass.
#UnitMyClass.TMyClass.Create
This is the description of the constructor of TMyClass.

Inside the item’s description, you can use all the PasDoc features and tags as documented on WritingDocumentation.

The --description command-line option may be used multiple times. All the description files will be processed.

If the item already had a description in the source code, then the description(s) from the external file are appended at the end to the existing descriptions, separated by a paragraph break.

PasDoc

• Download

Features:

• Where To Place Comments

• Writing Documentation

• Advanced Features

• Demo

• Projects Using PasDoc

• PasDoc vs FpDoc

• PasDoc GUI

• Other Tools

Supported Tags:

• @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

Command Line:

• Examples

• --format:
  • --format=html
  • --format=htmlhelp
  • --format=latex
  • --format=latex2rtf
  • --format=simplexml
  • --format=php

• --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:

• Compiling

• Development Snapshots

• Release Making

Developers pages:

• Do Di

• Garfield Fr

• Johannes Berg

• Michalis Kamburelis

• Thomas Mueller