Unit PasDoc_Types

Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants

Description

Basic types.

Source: source/component/PasDoc_Types.pas (line 27).

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class EPasDoc Exception raised in many situations when PasDoc encounters an error.

Functions and Procedures

function SplitNameParts(S: string; out NameParts: TNameParts): Boolean;
function OneNamePart(const S: string): TNameParts;
function GlueNameParts(const NameParts: TNameParts): string;

Types

TBytes = array of Byte;
UnicodeString = WideString;
RawByteString = AnsiString;
TStringArray = TStringDynArray;
TNameParts = TStringArray;
TPasDocMessageType = (...);
TPasDocMessageEvent = procedure(const MessageType: TPasDocMessageType; const AMessage: string; const AVerbosity: Cardinal) of object;
TCharSet = set of AnsiChar;
TImplicitVisibility = (...);

Constants

MaxNameParts = 3;
CP_UTF16 = 1200;
CP_UTF16Be = 1201;
CP_UTF32 = 12000;
CP_UTF32Be = 12001;

Description

Functions and Procedures

function SplitNameParts(S: string; out NameParts: TNameParts): Boolean;

Splits S, which can be made of any number of parts, separated by dots (Delphi namespaces, like PasDoc.Output.HTML.TWriter.Write). If S is not a valid identifier, False is returned, otherwise True is returned and splitted name is returned as NameParts.

Source: source/component/PasDoc_Types.pas (line 98).

function OneNamePart(const S: string): TNameParts;

Simply returns an array with Length = 1 and one item = S.

Source: source/component/PasDoc_Types.pas (line 101).

function GlueNameParts(const NameParts: TNameParts): string;

Simply concatenates all NameParts with dot.

Source: source/component/PasDoc_Types.pas (line 104).

Types

TBytes = array of Byte;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 38).

UnicodeString = WideString;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 41).

RawByteString = AnsiString;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 42).

TStringArray = TStringDynArray;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 51).

TNameParts = TStringArray;

This represents parts of a qualified name of some item.

User supplies such name by separating each part with dot, e.g. 'UnitName.ClassName.ProcedureName', then SplitNameParts converts it to TNameParts like ['UnitName', 'ClassName', 'ProcedureName']. Length must be always between 1 and MaxNameParts.

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

TPasDocMessageType = (...);

This item has no description.

Values
  • pmtPlainText
  • pmtInformation
  • pmtWarning
  • pmtError

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

TPasDocMessageEvent = procedure(const MessageType: TPasDocMessageType; const AMessage: string; const AVerbosity: Cardinal) of object;

This item has no description.

TCharSet = set of AnsiChar;

This item has no description.

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

TImplicitVisibility = (...);

See command-line option --implicit-visibility documentation at --implicit-visibility documentation.

Values
  • ivPublic
  • ivPublished
  • ivImplicit

Source: source/component/PasDoc_Types.pas (line 109).

Constants

MaxNameParts = 3;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 81).

CP_UTF16 = 1200;

Windows Unicode code page ID

Source: source/component/PasDoc_Types.pas (line 83).

CP_UTF16Be = 1201;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 84).

CP_UTF32 = 12000;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 85).

CP_UTF32Be = 12001;

This item has no description.

Source: source/component/PasDoc_Types.pas (line 86).

Authors

Generated by PasDoc 0.17.0.snapshot.