PasDoc's autodoc

Class TPasDoc

Description
Hierarchy
Fields
Methods
Properties

Unit

PasDoc_Base

Declaration

type TPasDoc = class(TComponent)

Description

The main object in the pasdoc application; first scans parameters, then parses files. All parsed units are then given to documentation generator, which creates one or more documentation output files.

Hierarchy

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;
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;

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.

Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;
 
Public constructor Create(AOwner: TComponent); override;

Creates object and sets fields to default values.

Public destructor Destroy; override;
 
Public procedure AddSourceFileNames(const AFileNames: TStringList);

Adds source filenames from a stringlist

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.

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

Raises an exception.

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

Forwards a message to the OnMessage event.

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

for Generator messages

Public procedure Execute;

Starts creating the documentation.

Properties

Public property Units: TPasUnits read FUnits;

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

Public property Conclusion: TExternalItem read FConclusion;

After Execute has been called, Conclusion holds the conclusion.

Public property Introduction: TExternalItem read FIntroduction;

After Execute has been called, Introduction holds the introduction.

Public property AdditionalFiles: TExternalItemList read FAdditionalFiles;

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

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;

This is deprecated name for OnMessage

Published property OnMessage: TPasDocMessageEvent read FOnMessage write FOnMessage;
 
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.

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;
 
Published property CacheDir: string read FCacheDir write FCacheDir;
 
Published property SortSettings: TSortSettings read FSortSettings write FSortSettings default [];

This determines how items inside will be sorted. See [https://github.com/pasdoc/pasdoc/wiki/SortOption].

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;

See command-line option --implicit-visibility documentation at [https://github.com/pasdoc/pasdoc/wiki/ImplicitVisibilityOption]. This will be passed to parser instance.

Published property HandleMacros: boolean read FHandleMacros write FHandleMacros default true;
 
Published property AutoLink: boolean read FAutoLink write FAutoLink default false;

This controls auto-linking, see [https://github.com/pasdoc/pasdoc/wiki/AutoLinkOption]

Published property AutoBackComments: boolean read FAutoBackComments write FAutoBackComments default false;
 
Published property InfoMergeType: TInfoMergeType read FInfoMergeType write FInfoMergeType;
 
Generated by PasDoc 0.16.0.