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

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

ReadDescriptionFromFile (last edited 2007-10-28 22:57:05 by localhost)