NaturalDocs:: Languages:: Pascal

NaturalDocs::Languages::Pascal

A subclass to handle the language variations of Pascal and Delphi.

Summary
A subclass to handle the language variations of Pascal and Delphi.
An existence hash of all the directives that can appear after a function prototype and will be included.
An existence hash of all the directives with parameters that can appear after a function prototype and will be included.
Pascal’s syntax uses the semicolons and commas parameter style shown below, yet also uses semicolons to end function prototypes.
Pascal’s syntax allows directives after the prototype, separated by semicolons.

Variables

prototypeDirectives

my %prototypeDirectives

An existence hash of all the directives that can appear after a function prototype and will be included.  The keys are the all lowercase keywords.

longPrototypeDirectives

my %longPrototypeDirectives

An existence hash of all the directives with parameters that can appear after a function prototype and will be included.  The keys are the all lowercase keywords.

Functions

EndOfPrototype

sub EndOfPrototype #(type,
stringRef,
falsePositives)

Pascal’s syntax uses the semicolons and commas parameter style shown below, yet also uses semicolons to end function prototypes.

function MyFunction( param1: type; param2, param3: type; param4: type);

There are also directives after the prototype that should be included.

function MyFunction ( param1: type ); virtual; abstract;

This function accounts for all of this.

FormatPrototype

sub FormatPrototype #(type,
prototype)

Pascal’s syntax allows directives after the prototype, separated by semicolons.

function MyFunction ( param1: type); virtual;

The default formatter would put the first semicolon with the post parameter section.  It will format better if it’s part of the closing parameter symbol.

A class containing the characteristics of a particular programming language for basic support within Natural Docs.
my %prototypeDirectives
An existence hash of all the directives that can appear after a function prototype and will be included.
my %longPrototypeDirectives
An existence hash of all the directives with parameters that can appear after a function prototype and will be included.
sub EndOfPrototype #(type,
stringRef,
falsePositives)
Pascal’s syntax uses the semicolons and commas parameter style shown below, yet also uses semicolons to end function prototypes.
sub FormatPrototype #(type,
prototype)
Pascal’s syntax allows directives after the prototype, separated by semicolons.