Class TExternalItem

Description
Hierarchy
Methods
Properties

Unit

PasDoc_Items

Declaration

type TExternalItem = class(TBaseItem)

Description

TExternalItem extends TBaseItem to store extra information about a project. TExternalItem is used to hold an introduction and conclusion to the project.

Source: source/component/PasDoc_Items.pas (line 951).

Hierarchy

Overview

Methods

Protected procedure HandleTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);
Protected procedure HandleShortTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);
Public Constructor Create; override;
Public destructor Destroy; override;
Public procedure RegisterTags(TagManager: TTagManager); override;
Public function FindItem(const ItemName: string): TBaseItem; override;
Public procedure AddAnchor(const AnchorItem: TAnchorItem); overload;
Public function AddAnchor(const AnchorName: string): TAnchorItem; overload;
Public function BasePath: string; override;

Properties

Public property OutputFileName: string read FOutputFileName write SetOutputFileName;
Public property ShortTitle: string read FShortTitle write FShortTitle;
Public property SourceFileName: string read FSourceFilename write FSourceFilename;
Public property Title: string read FTitle write FTitle;
Public property Anchors: TBaseItems read FAnchors;

Description

Methods

Protected procedure HandleTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);

This item has no description.

Source: source/component/PasDoc_Items.pas (line 961).

Protected procedure HandleShortTitleTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);

This item has no description.

Source: source/component/PasDoc_Items.pas (line 964).

Public Constructor Create; override;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 968).

Public destructor Destroy; override;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 969).

Public procedure RegisterTags(TagManager: TTagManager); override;

This item has no description. Showing description inherited from TBaseItem.RegisterTags.

It registers TTags that init Authors, Created, LastMod and remove relevant tags from description. You can override it to add more handlers.

Source: source/component/PasDoc_Items.pas (line 970).

Public function FindItem(const ItemName: string): TBaseItem; override;

This item has no description. Showing description inherited from TBaseItem.FindItem.

Search for an item called ItemName inside this Pascal item. For units, it searches for items declared inside this unit (like a procedure, or a class in this unit). For classes it searches for items declared within this class (like a method or a property). For an enumerated type, it searches for members of this enumerated type.

All normal rules of ObjectPascal scope apply, which means that e.g. if this item is a unit, FindItem searches for a class named ItemName but it doesn't search for a method named ItemName inside some class of this unit. Just like in ObjectPascal the scope of identifiers declared within the class always stays within the class. Of course, in ObjectPascal you can qualify a method name with a class name, and you can also do such qualified links in pasdoc, but this is not handled by this routine (see FindName instead).

Returns nil if not found.

Note that it never compares ItemName with Self.Name. You may want to check this yourself if you want.

Note that for TPasItem descendants, it always returns also some TPasItem descendant (so if you use this method with some TPasItem instance, you can safely cast result of this method to TPasItem).

Implementation in this class always returns nil. Override as necessary.

Source: source/component/PasDoc_Items.pas (line 976).

Public procedure AddAnchor(const AnchorItem: TAnchorItem); overload;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 977).

Public function AddAnchor(const AnchorName: string): TAnchorItem; overload;

If item with Name (case ignored) already exists, this raises exception EAnchorAlreadyExists. Otherwise it adds TAnchorItem with given name to Anchors. It also returns created TAnchorItem.

Source: source/component/PasDoc_Items.pas (line 982).

Public function BasePath: string; override;

This item has no description. Showing description inherited from TBaseItem.BasePath.

The full (absolute) path used to resolve filenames in this item's descriptions. Must always end with PathDelim. In this class, this simply returns GetCurrentDir (with PathDelim added if needed).

Source: source/component/PasDoc_Items.pas (line 989).

Properties

Public property OutputFileName: string read FOutputFileName write SetOutputFileName;

name of documentation output file

Source: source/component/PasDoc_Items.pas (line 972).

Public property ShortTitle: string read FShortTitle write FShortTitle;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 973).

Public property SourceFileName: string read FSourceFilename write FSourceFilename;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 974).

Public property Title: string read FTitle write FTitle;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 975).

Public property Anchors: TBaseItems read FAnchors;

Anchors holds a list of TAnchorItems that represent anchors and sections within the TExternalItem. The TAnchorItems have no content so, they should not be indexed separately.

Source: source/component/PasDoc_Items.pas (line 987).

Generated by PasDoc 0.17.0.snapshot.