Class TPasMethod

Unit

PasDoc_Items

Declaration

type TPasMethod = class(TPasItem)

Description

This represents:

1. global function/procedure,

2. method (function/procedure of a class/interface/object),

3. pointer type to one of the above (in this case Name is the type name).

Hierarchy

• TObject
• TSerializable
• TBaseItem
• TPasItem
• TPasMethod

Overview

Fields

	FReturns: string;
	FWhat: TMethodType;

Methods

	procedure Serialize(const ADestination: TStream); override;
	procedure Deserialize(const ASource: TStream); override;
	procedure StoreReturnsTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);
	constructor Create; override;
	destructor Destroy; override;
	procedure RegisterTags(TagManager: TTagManager); override;
	function HasOptionalInfo: boolean; override;

Properties

	property What: TMethodType read FWhat write FWhat;
	property Returns: string read FReturns;

Description

Fields

	FReturns: string;

	FWhat: TMethodType;

Methods

	procedure Serialize(const ADestination: TStream); override;

	procedure Deserialize(const ASource: TStream); override;

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

	constructor Create; override;

	destructor Destroy; override;

	procedure RegisterTags(TagManager: TTagManager); override;
In addition to inherited, this also registers TTag that inits Returns.

	function HasOptionalInfo: boolean; override;

Properties

	property What: TMethodType read FWhat write FWhat;

	property Returns: string read FReturns;
What does the method return. This is already in the form processed by TTagManager.Execute, i.e. with links resolved, html characters escaped etc. So don't convert them (e.g. before writing to the final docs) once again (by some ExpandDescription or ConvertString or anything like that).