PasDoc's autodoc

Unit PasDoc_Types

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

Description

Basic types.

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class EPasDoc  

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.

function OneNamePart(const S: string): TNameParts;

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

function GlueNameParts(const NameParts: TNameParts): string;

Simply concatenates all NameParts with dot.

Types

TBytes = array of Byte;
 
UnicodeString = WideString;
 
RawByteString = AnsiString;
 
TStringArray = TStringDynArray;
 
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.

TPasDocMessageType = (...);
 
Values
  • pmtPlainText
  • pmtInformation
  • pmtWarning
  • pmtError
TPasDocMessageEvent = procedure(const MessageType: TPasDocMessageType; const AMessage: string; const AVerbosity: Cardinal) of object;
 
TCharSet = set of AnsiChar;
 
TImplicitVisibility = (...);

See command-line option --implicit-visibility documentation at [https://github.com/pasdoc/pasdoc/wiki/ImplicitVisibilityOption]

Values
  • ivPublic
  • ivPublished
  • ivImplicit

Constants

MaxNameParts = 3;
 
CP_UTF16 = 1200;

Windows Unicode code page ID

CP_UTF16Be = 1201;
 
CP_UTF32 = 12000;
 
CP_UTF32Be = 12001;
 

Authors

Generated by PasDoc 0.16.0.