Class TPHPDocGenerator

Description
Hierarchy
Methods

Unit

PasDoc_GenPHP

Declaration

type TPHPDocGenerator = class(TDocGenerator)

Description

PHP output generator.

Source: source/component/PasDoc_GenPHP.pas (line 35).

Hierarchy

Overview

Methods

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

Description

Methods

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

Overrides of ancestor abstract methods, not really used by PHP generation. As we output only a simple map (name->html_filename) for PHP now, we don't really use most of these methods. But we override them, as they are absract in ancestor.

Source: source/component/PasDoc_GenPHP.pas (line 56).

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

This item has no description. Showing description inherited from TDocGenerator.WriteExternalCore.

This is called from WriteExternal when ExternalItem.Title and ShortTitle are already set, message about generating appropriate item is printed etc. This should write ExternalItem, including ExternalItem.DetailedDescription, ExternalItem.Authors, ExternalItem.Created, ExternalItem.LastMod.

Source: source/component/PasDoc_GenPHP.pas (line 57).

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

This item has no description. Showing description inherited from TDocGenerator.FormatSection.

Writes a section heading and a link-anchor.

Source: source/component/PasDoc_GenPHP.pas (line 59).

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

This item has no description. Showing description inherited from TDocGenerator.FormatAnchor.

Writes a link-anchor.

Source: source/component/PasDoc_GenPHP.pas (line 61).

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

This item has no description. Showing description inherited from TDocGenerator.FormatList.

Format a list from given ListData.

Source: source/component/PasDoc_GenPHP.pas (line 62).

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

This item has no description. Showing description inherited from TDocGenerator.FormatTable.

Return appropriate content for given Table. It's guaranteed that the Table passed here will have at least one row and in each row there will be at least one cell, so you don't have to check it within descendants.

Source: source/component/PasDoc_GenPHP.pas (line 63).

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

Overrides actually used.

Source: source/component/PasDoc_GenPHP.pas (line 66).

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

This item has no description. Showing description inherited from TDocGenerator.ConvertChar.

Converts a character to its converted form. This method should always be called to add characters to a string.

@ should also be converted by this routine.

Source: source/component/PasDoc_GenPHP.pas (line 67).

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

This item has no description. Showing description inherited from TDocGenerator.WriteUnit.

Abstract method that writes all documentation for a single unit U to output, starting at heading level HL. Implementation must be provided by descendant objects and is dependent on output format.

Source: source/component/PasDoc_GenPHP.pas (line 68).

Public procedure WriteDocumentation; override;

This item has no description. Showing description inherited from TDocGenerator.WriteDocumentation.

Must be overwritten, writes all documentation. Will create either a single file or one file for each unit and each class, interface or object, depending on output format.

Source: source/component/PasDoc_GenPHP.pas (line 70).

Public function GetFileExtension: String; override;

This item has no description. Showing description inherited from TDocGenerator.GetFileExtension.

Abstract function that provides file extension for documentation format. Must be overwritten by descendants.

Source: source/component/PasDoc_GenPHP.pas (line 71).

Generated by PasDoc 0.17.0.snapshot.