introduction

[tail] [up]

#### 3.3.1 introduction

The makeskel tool can be used to generate an empty description file for a unit. The description file will contain an element node for each identifier in the interface section of the Pascal unit.

It’s usage is quite straightforward: the name of an input file (one or more) must be specified (as for FPDoc), an output file, and the name of a package:

makeskel --package=rtl --input=crt.pp --output=crt.xml

This will read the file crt.pp and will create a file crt.xml which contains empty nodes for all identifiers found in crt.pp, all in a package named rtl.

The input option can be given more than once, as for the fpdoc command:

makeskel --input='-Sn system.pp' --input=crt.pp --output=rtl.xml

As can be seen, the input option can contain some compiler options, as is the case for FPDoc. The above command will process the files system.pp and crt.pp, and will create element tags for the identifiers in both units in the file rtl.xml.

The output of makeskel is a valid, empty description file. It will contain a module tag for each unit specified, and each module will have element tags for each identifier in the unit.

Each element tag will by default contain short, descr, errors and seealso tags, but this can be customised.

[front] [up]