Sign in Join
FPDoc Onlineexperiment

unitdiff program

Synopsis

unitdiff shows the differences between two unit interface sections.

unitdiff [--disable-arguments] [--disable-private] [--disable-protected]
[--help] [--lang=language] [--list] [--output=filename] [--sparse]
file1 file2

Description and usage

Unitdiff scans one or two Free Pascal unit source files and either lists all available identifiers, or describes the differences in identifiers between the two units.

You can invoke unitdiff with an input filename as the only required argument. It will then simply list all available identifiers.

The regular usage is to invoke unitdiff with two arguments:

unitdiff input1 input2

Invoked like this, it will show the difference in interface between the two units, or list the available identifiers in both units. The output of unitdiff will go to standard output by default.

Options

Most of the unitdiff options are not required. Defaults will be used in most cases.

–disable-arguments

Do not check the arguments of functions and procedures. The default action is to check them.

–disable-private

Do not check private fields or methods of classes. The default action is to check them.

–disable-protected

Do not check protected fields or methods of classes. The default action is to check them.

–help

Emit a short help text and exit.

–lang=language

Set the language for the output file. This will mainly set the strings used for the headers in various parts of the documentation files (by default they’re in English). Currently, valid options are:

  • de: German.

  • fr: French.

  • nl: Dutch.

–list

Display just the list of available identifiers for the unit or units. If only one unit is specified on the command line, this option is automatically assumed.

–output=filename

Specify where the output should go. The default action is to send the output is sent to standard output (the screen).

–sparse

Turn on sparse mode. Output only the identifier names. Do not output types or type descriptions. By default, type descriptions are also written.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.