TComment
Declaration
TComment = class(TTextObject)
Visibility
global
Immediate ancestor
TTextObject
Source
commonclasses.pas on line 178
Description
Represents a whole parsed, formatted comment.
Members
|
Name
|
Type
|
Visibility
|
Synopsis
|
|
Create
|
constructor
|
public
|
The argument is owned by the object and destroyed together with it.
|
|
Destroy
|
destructor
|
public
|
|
|
CopySelf
|
function
|
public
|
|
|
WriteOut
|
procedure
|
public
|
|
|
Synopsis
|
property
|
public
|
Returns the paragraph constituting the synopsis of the comment or nil if the comment does not have a synopsis.
|
|
Title
|
property
|
public
|
|
|
Profiles
|
property
|
public
|
If nil then all profiles are allowed.
|
|
IncludeDeclarations
|
property
|
public
|
The maximum number of following declarations that should be associated with this comment, provided that no other comment is found before these declarations.
|
|
FetchRelated
|
property
|
public
|
Indicates whether to prepend a comment of a related method to self.
|
|
|
TComment.Create
Declaration
constructor Create(aparas : TListAdt; asynopsis : TParagraph; atitle : String; aprofiles : TStrings; inclDecl : Cardinal; afetchRelated : Boolean);
Visibility
public
Source
commonclasses.pas on line 194
Description
The argument is owned by the object and destroyed together with it. Aparas is a list of TParagraph's, asynopsis is the sysopsis for the comment or nil if there's no synopsis.
TComment.Destroy
Declaration
destructor Destroy; override;
Visibility
public
Source
commonclasses.pas on line 197
TComment.CopySelf
Declaration
function CopySelf : TTextObject; override;
Visibility
public
Related methods
TTextObject.CopySelf
Source
commonclasses.pas on line 199
TComment.WriteOut
Declaration
procedure WriteOut(section : TSection); override;
Visibility
public
Related methods
TTextObject.WriteOut
Source
commonclasses.pas on line 198
TComment.Synopsis
Declaration
property Synopsis : TParagraph read FSynopsis;
Visibility
public
Source
commonclasses.pas on line 204
Description
Returns the paragraph constituting the synopsis of the comment or nil if the comment does not have a synopsis. A synopsis is a short (at most one sentence) summary of the whole comment. Non-nil if the comment has a synopsis;.
TComment.Title
Declaration
property Title : String read FTitle;
Visibility
public
Source
commonclasses.pas on line 205
TComment.Profiles
Declaration
property Profiles : TStrings read FProfiles;
Visibility
public
Source
commonclasses.pas on line 207
Description
If nil then all profiles are allowed.
TComment.IncludeDeclarations
Declaration
property IncludeDeclarations : Cardinal read FInclDecl;
Visibility
public
Source
commonclasses.pas on line 211
Description
The maximum number of following declarations that should be associated with this comment, provided that no other comment is found before these declarations.
TComment.FetchRelated
Declaration
property FetchRelated : Boolean read FFetchRelated;
Visibility
public
Source
commonclasses.pas on line 214
Description
Indicates whether to prepend a comment of a related method to self.