PasDoc's autodoc

Class TPasMethod

Description
Hierarchy
Fields
Methods
Properties

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

Overview

Fields

Protected FReturns: string;
Protected FWhat: TMethodType;
Protected FDirectives: TStandardDirectives;

Methods

Protected procedure Serialize(const ADestination: TStream); override;
Protected procedure Deserialize(const ASource: TStream); override;
Protected procedure StoreReturnsTag(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 HasOptionalInfo: boolean; override;

Properties

Public property What: TMethodType read FWhat write FWhat;
Public property Returns: string read FReturns;
Public property Directives: TStandardDirectives read FDirectives write FDirectives;

Description

Fields

Protected FReturns: string;
 
Protected FWhat: TMethodType;
 
Protected FDirectives: TStandardDirectives;
 

Methods

Protected procedure Serialize(const ADestination: TStream); override;
 
Protected procedure Deserialize(const ASource: TStream); override;
 
Protected procedure StoreReturnsTag(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;

In addition to inherited, this also registers TTag that inits Returns.

Public function HasOptionalInfo: boolean; override;
 

Properties

Public property What: TMethodType read FWhat write FWhat;
 
Public 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).

Public property Directives: TStandardDirectives read FDirectives write FDirectives;

Set of method directive flags

Generated by PasDoc 0.16.0.