Class TPasDoc

Description
Hierarchy
Methods
Properties

Unit

PasDoc_Base

Declaration

type TPasDoc = class(TComponent)

Description

Manages parsing and documentation generation.

Source: source/component/PasDoc_Base.pas (line 63).

Hierarchy

Show Additional Members:

Overview

Methods

Protected procedure RemoveExcludedItems(const c: TPasItems);
Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;
Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure AddSourceFileNames(const AFileNames: TStringList);
Public procedure AddSourceFileNamesFromFile(const FileName: string; DashMeansStdin: boolean);
Public procedure DoError(const AMessage: string; const AArguments: array of const; const AExitCode: Word);
Public procedure DoMessage(const AVerbosity: Cardinal; const AMessageType: TPasDocMessageType; const AMessage: string; const AArguments: array of const);
Public procedure GenMessage(const MessageType: TPasDocMessageType; const AMessage: string; const AVerbosity: Cardinal);
Public procedure Execute;

Properties

Public property Units: TPasUnits read FUnits;
Public property Conclusion: TExternalItem read FConclusion;
Public property Introduction: TExternalItem read FIntroduction;
Public property AdditionalFiles: TExternalItemList read FAdditionalFiles;
Published property DescriptionFileNames: TStringVector read FDescriptionFileNames write SetDescriptionFileNames;
Published property Directives: TStringVector read FDirectives write SetDirectives;
Published property IncludeDirectories: TStringVector read FIncludeDirectories write SetIncludeDirectories;
Published property OnWarning: TPasDocMessageEvent read FOnMessage write FOnMessage stored false;
Published property OnMessage: TPasDocMessageEvent read FOnMessage write FOnMessage;
Published property ProjectName: string read FProjectName write FProjectName;
Published property SourceFileNames: TStringVector read FSourceFileNames write SetSourceFileNames;
Published property Title: string read FTitle write FTitle;
Published property Verbosity: Cardinal read FVerbosity write FVerbosity default DEFAULT_VERBOSITY_LEVEL;
Published property StarOnly: boolean read GetStarOnly write SetStarOnly stored false;
Published property CommentMarkers: TStringList read FCommentMarkers write SetCommentMarkers;
Published property IgnoreMarkers: TStringList read FIgnoreMarkers write SetIgnoreMarkers;
Published property MarkerOptional: boolean read FMarkerOptional write FMarkerOptional default false;
Published property IgnoreLeading: string read FIgnoreLeading write FIgnoreLeading;
Published property Generator: TDocGenerator read FGenerator write SetGenerator;
Published property ShowVisibilities: TVisibilities read FShowVisibilities write FShowVisibilities default DefaultVisibilities;
Published property ToggleVisibilities: TVisibilities read FToggleVisibilities write FToggleVisibilities default [];
Published property CacheDir: string read FCacheDir write FCacheDir;
Published property SortSettings: TSortSettings read FSortSettings write FSortSettings default [];
Published property IntroductionFileName: string read FIntroductionFileName write FIntroductionFileName;
Published property ConclusionFileName: string read FConclusionFileName write FConclusionFileName;
Published property AdditionalFilesNames: TStringList read FAdditionalFilesNames;
Published property ImplicitVisibility: TImplicitVisibility read FImplicitVisibility write FImplicitVisibility default ivPublic;
Published property HandleMacros: boolean read FHandleMacros write FHandleMacros default true;
Published property AutoLink: boolean read FAutoLink write FAutoLink default false;
Published property AutoBackComments: boolean read FAutoBackComments write FAutoBackComments default false;
Published property InfoMergeType: TInfoMergeType read FInfoMergeType write FInfoMergeType default imtNone;

Description

Methods

Protected procedure RemoveExcludedItems(const c: TPasItems);

Searches the description of each TPasUnit item in the collection for an excluded tag. If one is found, the item is removed from the collection. If not, the fields, methods and properties collections are called with RemoveExcludedItems If the collection is empty after removal of all items, it is disposed of and the variable is set to nil.

Source: source/component/PasDoc_Base.pas (line 127).

Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 129).

Public constructor Create(AOwner: TComponent); override;

Creates object and sets fields to default values.

Source: source/component/PasDoc_Base.pas (line 132).

Public destructor Destroy; override;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 134).

Public procedure AddSourceFileNames(const AFileNames: TStringList);

Adds source filenames from a stringlist

Source: source/component/PasDoc_Base.pas (line 137).

Public procedure AddSourceFileNamesFromFile(const FileName: string; DashMeansStdin: boolean);

Loads names of Pascal unit source code files from a text file. Adds all file names to SourceFileNames. If DashMeansStdin and AFileName = '-' then it will load filenames from stdin.

Source: source/component/PasDoc_Base.pas (line 142).

Public procedure DoError(const AMessage: string; const AArguments: array of const; const AExitCode: Word);

Raises an exception.

Source: source/component/PasDoc_Base.pas (line 145).

Public procedure DoMessage(const AVerbosity: Cardinal; const AMessageType: TPasDocMessageType; const AMessage: string; const AArguments: array of const);

Forwards a message to the OnMessage event.

Source: source/component/PasDoc_Base.pas (line 148).

Public procedure GenMessage(const MessageType: TPasDocMessageType; const AMessage: string; const AVerbosity: Cardinal);

for Generator messages

Source: source/component/PasDoc_Base.pas (line 151).

Public procedure Execute;

Starts creating the documentation.

Source: source/component/PasDoc_Base.pas (line 154).

Properties

Public property Units: TPasUnits read FUnits;

After Execute has been called, Units holds the units that have been parsed.

Source: source/component/PasDoc_Base.pas (line 157).

Public property Conclusion: TExternalItem read FConclusion;

After Execute has been called, Conclusion holds the conclusion.

Source: source/component/PasDoc_Base.pas (line 159).

Public property Introduction: TExternalItem read FIntroduction;

After Execute has been called, Introduction holds the introduction.

Source: source/component/PasDoc_Base.pas (line 161).

Public property AdditionalFiles: TExternalItemList read FAdditionalFiles;

After Execute has been called, AdditionalFiles holds the additional external files.

Source: source/component/PasDoc_Base.pas (line 163).

Published property DescriptionFileNames: TStringVector read FDescriptionFileNames write SetDescriptionFileNames;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 165).

Published property Directives: TStringVector read FDirectives write SetDirectives;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 167).

Published property IncludeDirectories: TStringVector read FIncludeDirectories write SetIncludeDirectories;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 168).

Published property OnWarning: TPasDocMessageEvent read FOnMessage write FOnMessage stored false;

This is deprecated name for OnMessage

Source: source/component/PasDoc_Base.pas (line 172).

Published property OnMessage: TPasDocMessageEvent read FOnMessage write FOnMessage;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 174).

Published property ProjectName: string read FProjectName write FProjectName;

The name PasDoc shall give to this documentation project, also used to name some of the output files.

Source: source/component/PasDoc_Base.pas (line 178).

Published property SourceFileNames: TStringVector read FSourceFileNames write SetSourceFileNames;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 179).

Published property Title: string read FTitle write FTitle;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 181).

Published property Verbosity: Cardinal read FVerbosity write FVerbosity default DEFAULT_VERBOSITY_LEVEL;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 182).

Published property StarOnly: boolean read GetStarOnly write SetStarOnly stored false;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 184).

Published property CommentMarkers: TStringList read FCommentMarkers write SetCommentMarkers;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 185).

Published property IgnoreMarkers: TStringList read FIgnoreMarkers write SetIgnoreMarkers;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 186).

Published property MarkerOptional: boolean read FMarkerOptional write FMarkerOptional default false;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 187).

Published property IgnoreLeading: string read FIgnoreLeading write FIgnoreLeading;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 189).

Published property Generator: TDocGenerator read FGenerator write SetGenerator;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 191).

Published property ShowVisibilities: TVisibilities read FShowVisibilities write FShowVisibilities default DefaultVisibilities;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 192).

Published property ToggleVisibilities: TVisibilities read FToggleVisibilities write FToggleVisibilities default [];

Visibilities that should be included in HTML output but hidden by default, with checkboxes to toggle their display.

Source: source/component/PasDoc_Base.pas (line 197).

Published property CacheDir: string read FCacheDir write FCacheDir;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 199).

Published property SortSettings: TSortSettings read FSortSettings write FSortSettings default [];

How items will be sorted. See --sort documentation.

This class sorts the items in TDocGenerator.Units before executing TDocGenerator.WriteDocumentation, so TDocGenerator usually doesn't need to worry about sorting anymore... Except if output rearranges/sums items, like HTML output does for InheritedMembers<>imNever, in which case they need to be sorted again.

Source: source/component/PasDoc_Base.pas (line 209).

Published property IntroductionFileName: string read FIntroductionFileName write FIntroductionFileName;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 212).

Published property ConclusionFileName: string read FConclusionFileName write FConclusionFileName;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 215).

Published property AdditionalFilesNames: TStringList read FAdditionalFilesNames;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 218).

Published property ImplicitVisibility: TImplicitVisibility read FImplicitVisibility write FImplicitVisibility default ivPublic;

See command-line option --implicit-visibility documentation at --implicit-visibility documentation. This will be passed to parser instance.

Source: source/component/PasDoc_Base.pas (line 223).

Published property HandleMacros: boolean read FHandleMacros write FHandleMacros default true;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 226).

Published property AutoLink: boolean read FAutoLink write FAutoLink default false;

This controls auto-linking, see --auto-link documentation.

Source: source/component/PasDoc_Base.pas (line 231).

Published property AutoBackComments: boolean read FAutoBackComments write FAutoBackComments default false;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 233).

Published property InfoMergeType: TInfoMergeType read FInfoMergeType write FInfoMergeType default imtNone;

This item has no description.

Source: source/component/PasDoc_Base.pas (line 235).

Generated by PasDoc 1.0.2.