ReadDescriptionFromFile

Michalis Kamburelis edited this page Jan 19, 2017 · 6 revisions
Clone this wiki locally

In addition to comments in source files PasDoc uses external files specified by the --description (short form -R) option on the CommandLine.

Example:

pasdoc --description unit1.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 is a fully qualified name of the item to be described, e.g. UnitName.Class.PropertyOrMethod.

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.

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