Makeskel option reference

The output of makeskel can be customised using several options, which are discussed below.

descr

When in update mode (), this option can be used to add an existing documentation file, as for fpdoc. Nodes that are already in one of the existing documentation files will not be written to the output file.

disable-arguments

By default, for each function or procedure argument, a tag will be generated. This option disables this behaviour: no tags will be generated for procedure and function arguments.

disable-errors

If this option is specified, no tag will be generated in the element nodes. By default all element tags contain a node.

The tag is ignored when it is not needed; Normally, an tag is only needed for procedure and function elements.

disable-function-results

If this option is specified, then no tag will be generated for function results. By default, makeskel will generate a result node for each function in the interface section. The result node is used in the documentation to document the return value of the function under a separate heading in the documentation page. Specifying this option suppresses the generation of the tag for the function result.

disable-override

If this option is specified, then no tags will be generated for methods that override a method in a parent class. This means that the fpdoc engine will refer to the parent implementation for the documentation of the inherited method (provided it can find a parent implementation).

disable-private

If this option is specified, then no tags will be generated for private methods or fields of classes or objects. The default behavior is to generate nodes for private methods or fields. It can be used to generate a skeleton for end-user and developer documentation.

disable-protected

If this option is specified, then no tags will be generated for protected and private methods or fields of classes or objects. The default is to generate nodes for protected methods or fields. If this option is given, the option --disable-private is implied. It can be used to generate end-user-only documentation for classes.

disable-seealso

If this option is specified, no tag will be generated in the element nodes. By default all tags contain a tag.

emitclassseparator

When this option is specified, at the beginning of the elements for the documentation of a class, a comment tag is emitted which contains a separator text. This can be useful to separate documentation of different classes and make the description file more understandable.

help

Makeskel emits a short copyright notice and exits when this option is specified.

input

This option is identical in meaning and functionality as the input option for . () It specifies the Pascal unit source file that will be scanned and for which a skeleton description file will be generated. Multiple input options can be given, and tags will be written for all the files, in one big output file.

lang

This option is used to specify the language for messages emitted by makeskel. The supported languages are identical to the ones for :

de

German.

fr

French.

nl

Dutch.

output

This option specifies the name of the output file. A full filename must be given, no extension will be added. If this option is omitted, the output will be sent to standard output.

When using update mode, the output file name should not appear in the list of existing documentation files. The makeskel program will do some elementary checks on this.

package

This option specifies the package name that will be used when generating the skeleton. It is a mandatory option.

update

This option tells makeskel to create an update file: it will read description files () and will only create documentation nodes for identifiers which do not yet have a documentation node in the read documentation files. The output file in this case can be merged with one (or more) of the documentation files: it’s name should not appear in the list of existing documentation files. The makeskel program will do some elementary checks on this.