Class TSimpleXMLDocGenerator

Unit

PasDoc_GenSimpleXML

Declaration

type TSimpleXMLDocGenerator = class(TDocGenerator)

Description

basic documentation generator object

This abstract object will do the complete process of writing documentation files. It will be given the collection of units that was the result of the parsing process and a configuration object that was created from default values and program parameters. Depending on the output format, one or more files may be created (HTML will create several, Tex only one).

Hierarchy

• TComponent
• TDocGenerator
• TSimpleXMLDocGenerator

Overview

Methods

	function CodeString(const s: string): string; override;
	function ConvertString(const s: string): string; override;
	function ConvertChar(c: char): string; override;
	procedure WriteUnit(const HL: integer; const U: TPasUnit); override;
	procedure WriteExternalCore(const ExternalItem: TExternalItem; const Id: TTranslationID); override;
	function FormatSection(HL: integer; const Anchor: string; const Caption: string): string; override;
	function FormatAnchor(const Anchor: string): string; override;
	function FormatTable(Table: TTableData): string; override;
	function FormatList(ListData: TListData): string; override;
	procedure WriteDocumentation; override;
	function GetFileExtension: string; override;

Description

Methods

	function CodeString(const s: string): string; override;

	function ConvertString(const s: string): string; override;

	function ConvertChar(c: char): string; override;

	procedure WriteUnit(const HL: integer; const U: TPasUnit); override;

	procedure WriteExternalCore(const ExternalItem: TExternalItem; const Id: TTranslationID); override;

	function FormatSection(HL: integer; const Anchor: string; const Caption: string): string; override;

	function FormatAnchor(const Anchor: string): string; override;

	function FormatTable(Table: TTableData): string; override;

	function FormatList(ListData: TListData): string; override;

	procedure WriteDocumentation; override;

	function GetFileExtension: string; override;