TDocWriter
Declaration
TDocWriter = class
Visibility
global
Immediate descendants
THtmlWriter
Source
commonclasses.pas on line 296
Description
An abstract interface of a documentation writer. It only returns the right type of a section, and the section does the main job.
Members
TDocWriter.Create
Declaration
constructor Create(aOutputDir : String);
Visibility
public
Source
commonclasses.pas on line 303
Description
Creates a writer.
TDocWriter.RegisterSection
Declaration
function RegisterSection(name : String; parent : TSection; big : Boolean) : TSection; virtual; abstract;
Visibility
public
Source
commonclasses.pas on line 310
Description
Registeres a section named name. parent Is the section which contains the registered section. Should be nil if no such section exists. If the section is expected to contain many subsections then big should be true. Such a section is typically written to a separate file. The section returned by this function should be freed be the caller.
TDocWriter.RegisterContentsSection
Declaration
function RegisterContentsSection : TSection; virtual; abstract;
Visibility
public
Source
commonclasses.pas on line 314
Description
Registeres a special section for the table of contents. The returned section should be destroyed by the caller.
TDocWriter.RegisterClassTreeSection
Declaration
function RegisterClassTreeSection : TSection; virtual; abstract;
Visibility
public
Source
commonclasses.pas on line 317
Description
Registeres a special section for the tree of classes. The returned section should be destroyed by the caller.
TDocWriter.RegisterInterfaceTreeSection
Declaration
function RegisterInterfaceTreeSection : TSection; virtual; abstract;
Visibility
public
Source
commonclasses.pas on line 320
Description
Registeres a special section for the tree of interfaces. The returned section should be destroyed by the caller.
TDocWriter.RegisterSymbolIndexSection
Declaration
function RegisterSymbolIndexSection : TSection; virtual; abstract;
Visibility
public
Source
commonclasses.pas on line 323
Description
Registeres a special section for the index of symbols. The returned section should be destroyed by the caller.
TDocWriter.OutputDirectory
Declaration
property OutputDirectory : String read FOutputDir;
Visibility
protected
Source
commonclasses.pas on line 300