All Identifiers

Name	Unit	Description
AllChars	PasDoc_Utils
AllSortSettings	PasDoc_SortSettings
AllVisibilities	PasDoc_Items
CfgMacroCfgPath	PasDoc_OptionParser	Special substitution that, if found inside a config file, will be replaced with actual path of the file
CharsPos	PasDoc_Utils	Find first occurrence of any character in Chars in string S.
CheckGetFileDate	PasDoc_Utils
CIONonHierarchy	PasDoc_Items
CIORecordType	PasDoc_Items
CioTypeToString	PasDoc_Items	Returns lowercased keyword(s) associated with given structure type.
CombinePaths	PasDoc_Utils	Combines BasePath with RelPath.
COMPILER_BITS	PasDoc_Versions
COMPILER_NAME	PasDoc_Versions	Nice compiler name.
ConsoleWidth	PasDoc_OptionParser	Width of console
ConvertHelpInsightDescription	PasDoc_Utils	Convert HelpInsight description to PasDoc description, by converting HelpInsight tags like <summary>...</summary> to PasDoc @tags like @abstract.
CopyFile	PasDoc_Utils
DataToFile	PasDoc_Utils	Save the binary Data into a file.
DefaultVisibilities	PasDoc_Items	Default visibility, as documented on https://pasdoc.github.io/VisibleMembers
DEFAULT_LANGUAGE	PasDoc_Languages
DEFAULT_VERBOSITY_LEVEL	PasDoc_Base
DefLongOptionString	PasDoc_OptionParser	default long option string used
DefShortOptionChar	PasDoc_OptionParser	default short option character used
DeleteFileExt	PasDoc_Utils	Remove from the FileName the last extension (including the dot).
EAnchorAlreadyExists	PasDoc_Items
EInternalParserError	PasDoc_Parser	Raised when an impossible situation (indicating bug in pasdoc) occurs.
EInvalidCacheFileVersion	PasDoc_Serialize
EInvalidIfCondition	PasDoc_Scanner
EInvalidSortSetting	PasDoc_SortSettings
EmptyRawDescriptionInfo	PasDoc_Items
EPasDoc	PasDoc_Types	Exception raised in many situations when PasDoc encounters an error.
ESerializedException	PasDoc_Serialize
ETokenizerStreamEnd	PasDoc_Scanner
ExtractFirstWord	PasDoc_Utils	Extracts all characters up to the first white-space encountered (ignoring white-space at the very beginning of the string) from the string specified by S.
ExtractFirstWord	PasDoc_Utils	Another version of ExtractFirstWord.
FileToString	PasDoc_Utils	Read the given FileName contents into a String.
FlagEndSigns	PasDoc_Utils
FlagStartSigns	PasDoc_Utils	Flag Start- and Endsigns for parameters (Feature request "direction of parameter": pasdoc issue 8)
GlueNameParts	PasDoc_Types	Simply concatenates all NameParts with dot.
HighCreatedOverviewFile	PasDoc_Gen
InfoMergeTypeStr	PasDoc_Items
IsEmpty	PasDoc_StringVector
IsIdentifierOtherChar	PasDoc_Tokenizer	Returns true if c is a valid continuation character of a Pascal identifier: underscore, ASCII letter, ASCII digit, or non-ASCII character (Unicode letter/digit).
IsIdentifierStartChar	PasDoc_Tokenizer	Returns true if c is a valid first character of a Pascal identifier: underscore, ASCII letter, or non-ASCII character (Unicode letter).
IsPathAbsolute	PasDoc_Utils	Check is the given Path absolute.
IsPathAbsoluteOnDrive	PasDoc_Utils	Just like IsPathAbsolute, but on Windows accepts also paths that specify full directory tree without drive letter.
IsPrefix	PasDoc_Utils	Is given Prefix a prefix of S.
IsStrEmptyA	PasDoc_Utils	string empty means it contains only whitespace
IsSuffix	PasDoc_Utils	Is given Suffix a suffix of S.
IsValidMultipartName	PasDoc_Types	Checks that the string is a valid multipart identifier
KeyWordArray	PasDoc_Tokenizer	all Object Pascal keywords
KeyWordByName	PasDoc_Tokenizer	Checks is Name (case ignored) some Pascal standard directive.
LanguageCode	PasDoc_Languages	Language code, using an official standardardized language names, suitable for Aspell or HTML.
LanguageFromStr	PasDoc_Languages	Find a language with Syntax = S (case ignored).
LanguageInformation	PasDoc_Languages	Read-only language information.
LowCreatedOverviewFile	PasDoc_Gen	Using High(TCreatedOverviewFile) or High(Overview) where Overview: TCreatedOverviewFile in PasDoc_GenHtml produces internal error in FPC 2.0.0.
Main	PasDoc_Main	Does the complete job of the command-line PasDoc.
MakeMethod	PasDoc_Utils	creates a "method pointer"
MAX_TOKENIZERS	PasDoc_Scanner	maximum number of streams we can recurse into; first one is the unit stream, any other stream an include file; current value is 32, increase this if you have more include files recursively including others
NewStringCardinalTree	PasDoc_HierarchyTree
NewStringVector	PasDoc_StringVector
ObjectVectorIsNilOrEmpty	PasDoc_Items	Is List nil or empty.
OneNamePart	PasDoc_Types	Simply returns an array with Length = 1 and one item = S.
OptionFileChar	PasDoc_OptionParser	Marks "include config file" option
OptionIndent	PasDoc_OptionParser	Indentation of option's name from the start of console line
OptionSep	PasDoc_OptionParser	Separator between option's name and explanation
OverviewFilesInfo	PasDoc_Gen
PASDOC_DATE	PasDoc_Versions	PASDOC_DATE = '2026-03-30';
PASDOC_FULL_INFO	PasDoc_Versions	Returns pasdoc name, version, used compiler version, etc.
PASDOC_HOMEPAGE	PasDoc_Versions
PASDOC_NAME	PasDoc_Versions
PASDOC_NAME_AND_VERSION	PasDoc_Versions
PASDOC_VERSION	PasDoc_Versions	PASDOC_VERSION = '1.0.2';
PLanguageRecord	PasDoc_Languages
PRawDescriptionInfo	PasDoc_Items
PTransTable	PasDoc_Languages
RawByteString	PasDoc_Types
Register	PasDoc_Reg	Registers the PasDoc components into the IDE.
RemoveIndentation	PasDoc_Utils	Remove common indentation (whitespace prefix) from a multiline string.
RemovePrefix	PasDoc_Utils	If IsPrefix(Prefix, S), then remove the prefix, otherwise return unmodifed S.
RemoveSuffix	PasDoc_Utils	If IsSuffix(Suffix, S), then remove the suffix, otherwise return unmodifed S.
RoutineTypeToString	PasDoc_Items	Returns lowercased keyword associated with given method type.
RTransTable	PasDoc_Languages	Array holding the translated strings (or strKeep or strToDo markers) for a language.
SAppendPart	PasDoc_Utils	If S = '' then returns NextPart, else returns S + PartSeparator + NextPart.
SCharIs	PasDoc_Utils	Comfortable shortcut for Index <= Length(S) and S[Index] = C.
SCharIs	PasDoc_Utils	Comfortable shortcut for Index <= Length(S) and S[Index] in Chars.
SCharsReplace	PasDoc_Utils
SCharsReplace	PasDoc_Utils	Returns S with all Chars replaced by ReplacementChar
SEnding	PasDoc_Utils	SEnding returns S contents starting from position P.
SignatureToHtmlId	PasDoc_GenHtml	DON'T EDIT – this file was automatically generated from "pasdoc.css"
SkipBOM	PasDoc_Utils	Interpret and skip the BOM in the InputStream.
SortSettingFromName	PasDoc_SortSettings
SortSettingNames	PasDoc_SortSettings	Must be lowercase.
SortSettingsToName	PasDoc_SortSettings	Comma-separated list
SplitNameParts	PasDoc_Types	Splits S, which can be made of any number of parts, separated by dots (Delphi namespaces, like PasDoc.Output.HTML.TWriter.Write).
SRemoveChars	PasDoc_Utils	Remove all instances of a character in Chars from a string.
StandardDirectiveArray	PasDoc_Tokenizer	Object Pascal directives
StandardDirectiveByName	PasDoc_Tokenizer	Checks is Name (case ignored) some Pascal keyword.
StrCountCharA	PasDoc_Utils	count occurences of AChar in AString
StreamReadLine	PasDoc_StreamUtils	Read next line from AStream, return it as AnsiString.
StreamWriteLine	PasDoc_StreamUtils	Write AString contents, then LineEnding to AStream.
StreamWriteString	PasDoc_StreamUtils	Just write AString contents to AStream.
StringPairIsNilOrEmpty	PasDoc_StringPairVector
StringReplaceChars	PasDoc_Utils	Returns S with each char from ReplacementArray[].cChar replaced with ReplacementArray[].sSpec.
StringToFile	PasDoc_Utils	Save the String content into a file.
StringToImplicitVisibility	PasDoc_Types
StringToInheritedMembers	PasDoc_GenHtml
StringToLinkLook	PasDoc_Gen
StripHtml	PasDoc_Utils	Strip HTML elements from the string.
StripNamePart	PasDoc_Types	Strip one name part.
StrPosIA	PasDoc_Utils	Position of the ASub in AString.
SymbolNames	PasDoc_Tokenizer	Symbols as strings.
TAnchorItem	PasDoc_Items
TAspellProcess	PasDoc_Aspell	This is a class to interface with aspell through pipe.
TBaseItem	PasDoc_Items	This is a basic item class, that is linkable, and has some RawDescription.
TBaseItemDictionary	PasDoc_Items
TBaseItems	PasDoc_Items	Container class to store a list of TBaseItems.
TBoolOption	PasDoc_OptionParser	Boolean option, "on" if was specified.
TBufferedFileStream	PasDoc_StreamUtils
TBytes	PasDoc_Types
TCharReplacement	PasDoc_Utils
TCharSet	PasDoc_Types	Set of AnsiChars.
TCioState	PasDoc_Parser	State of parsing a structure (called "CIO" throughout PasDoc codebase).
TCioStateStack	PasDoc_Parser	A stack of TCioState objects currently used to parse nested classes and records.
TCIOType	PasDoc_Items	Determine type of TPasCio item, like a class or record.
TClassDirective	PasDoc_Items
TCreatedOverviewFile	PasDoc_Gen
TDirectiveType	PasDoc_Scanner	All directives a scanner is going to regard.
TDocGenerator	PasDoc_Gen	Base generator class, to be specialized for specific output formats.
TExternalItem	PasDoc_Items	`TExternalItem` extends TBaseItem to store extra information about a project.
TExternalItemList	PasDoc_Items
TGenericHTMLDocGenerator	PasDoc_GenHtml	HTML documentation generator.
THintDirective	PasDoc_Items
THintDirectives	PasDoc_Items
THTMLDocGenerator	PasDoc_GenHtml	Right now this is the same thing as TGenericHTMLDocGenerator.
THTMLHelpDocGenerator	PasDoc_GenHtmlHelp
TImplicitVisibility	PasDoc_Types	See command-line option --implicit-visibility documentation at --implicit-visibility documentation.
TInfoMergeType	PasDoc_Items	Type of merging interface and implementation comments.
TInheritedMembers	PasDoc_GenHtml	Show we show inherited members (in outputs that make it possible, which right now means only HTML output).
TIntegerOption	PasDoc_OptionParser	Option that accepts additional Integer as a value.
TipueAddFiles	PasDoc_Tipue	Adds some additional files to html documentation, needed for tipue engine.
TipueSearchButton	PasDoc_Tipue	Put this at a place where Tipue button should appear.
TipueSearchButtonHead	PasDoc_Tipue	Put this in <head> of every page with search button.
TKeyword	PasDoc_Tokenizer
TLanguageID	PasDoc_Languages	An enumeration type of all supported languages
TLanguageRecord	PasDoc_Languages
TLinkContext	PasDoc_Gen	This is used by TDocGenerator.MakeItemLink
TLinkLook	PasDoc_Gen
TLinkNotFoundAction	PasDoc_Gen
TListData	PasDoc_Gen	Collected information about @xxxList content.
TListItemData	PasDoc_Gen	Collected information about @xxxList item.
TListItemSpacing	PasDoc_Gen
TListType	PasDoc_Gen
TNameParts	PasDoc_Types	Qualified name of a Pascal item.
TNonSelfTag	PasDoc_TagManager
TokenCommentTypes	PasDoc_Tokenizer
TOKEN_TYPE_NAMES	PasDoc_Tokenizer	Names of the token types.
TOption	PasDoc_OptionParser	Base class for options.
TOptionParser	PasDoc_OptionParser	OptionParser — instantiate one of these for commandline parsing
TOverviewFile	PasDoc_Gen	Overview files that pasdoc generates for multiple-document-formats like HTML (see TGenericHTMLDocGenerator).
TOverviewFileInfo	PasDoc_Gen
TParser	PasDoc_Parser	Parser class that will process a complete unit file and all of its include files, regarding directives.
TParsingSection	PasDoc_Parser	Are we currently inside a const, var, type section?
TPasAliasType	PasDoc_Items	Alias type
TPasCio	PasDoc_Items	Extends TPasItem to store all items in a class / an object, e.g. fields.
TPasConstant	PasDoc_Items	Pascal constant.
TPasDoc	PasDoc_Base	Manages parsing and documentation generation.
TPasDocLanguages	PasDoc_Languages	Language class to hold all translated strings
TPasDocMessageEvent	PasDoc_Types	Callback to send a message from one class and react to it in another.
TPasDocMessageType	PasDoc_Types	Message type to send with TPasDocMessageEvent.
TPasEnum	PasDoc_Items	Enumerated type.
TPasFieldVariable	PasDoc_Items	Global variable or a field in CIO.
TPasItem	PasDoc_Items	This is a TBaseItem descendant that is always declared inside some Pascal source file.
TPasItemNode	PasDoc_HierarchyTree
TPasItems	PasDoc_Items	Container class to store a list of TPasItems.
TPasNestedCios	PasDoc_Items	Collection of CIOs (classes, records, interfaces...) nested in outer CIO.
TPasProperties	PasDoc_Items	Collection of properties.
TPasProperty	PasDoc_Items
TPasRoutine	PasDoc_Items	This represents: global function/procedure, method (function/procedure of a structure (TPasCio)), type (pointer to one of the above) (in this case Name is the type name).
TPasRoutines	PasDoc_Items	Collection of methods.
TPasType	PasDoc_Items	Pascal type (but not a procedural type — these are expressed as TPasRoutine.)
TPasTypes	PasDoc_Items	List of types.
TPasUnit	PasDoc_Items	extends TPasItem to store anything about a unit, its constants, types etc.; also provides methods for parsing a complete unit.
TPasUnits	PasDoc_Items	Collection of units.
TPathListOption	PasDoc_OptionParser	pathlist option
TPHPDocGenerator	PasDoc_GenPHP	PHP output generator.
TProcessLineTalk	PasDoc_ProcessLineTalk	This is a subclass of TProcess that allows to easy "talk" with executed process by pipes (read process stdout/stderr, write to process stdin) on a line-by-line basis.
TRawDescriptionInfo	PasDoc_Items	Raw description, in other words: the contents of comment before given item.
TRawDescriptionInfoList	PasDoc_Parser	`TRawDescriptionInfoList` stores a series of TRawDescriptionInfos.
TRoutineType	PasDoc_Items	Routine type for TPasRoutine.What
TRowData	PasDoc_Gen	Collected information about @row (or @rowHead).
TScanner	PasDoc_Scanner	Scanner for Pascal, producing tokens and interpreting conditionals Returns tokens from a Pascal language source code input stream.
TSerializable	PasDoc_Serialize
TSerializableClass	PasDoc_Serialize
TSetOption	PasDoc_OptionParser	Option that allows to define a set.
TSimpleXMLDocGenerator	PasDoc_GenSimpleXML
TSortSetting	PasDoc_SortSettings
TSortSettings	PasDoc_SortSettings
TSpellingError	PasDoc_Aspell	Single misspelling found by TAspellProcess.CheckString.
TSpellingErrorList	PasDoc_Aspell
TStandardDirective	PasDoc_Tokenizer
TStandardDirectives	PasDoc_Tokenizer
TStringArray	PasDoc_Types	Dynamic array of String.
TStringCardinalTree	PasDoc_HierarchyTree
TStringConverter	PasDoc_TagManager
TStringOption	PasDoc_OptionParser	Option that accepts additional string as a value.
TStringOptionList	PasDoc_OptionParser	stringlist option
TStringPair	PasDoc_StringPairVector
TStringPairVector	PasDoc_StringPairVector	List of string pairs.
TStringStringDictionary	PasDoc_Items
TStringVector	PasDoc_StringVector
TSwitchOptions	PasDoc_Scanner	an array of boolean values, index type is TUpperCaseLetter
TSymbolType	PasDoc_Tokenizer	enumeration type that provides all types of symbols; each symbol's name starts with SYM_
TTableData	PasDoc_Gen	Collected information about @table.
TTag	PasDoc_TagManager
TTagAllowedInsideEvent	PasDoc_TagManager
TTagExecuteEvent	PasDoc_TagManager
TTagManager	PasDoc_TagManager
TTagOption	PasDoc_TagManager
TTagOptions	PasDoc_TagManager
TTagVector	PasDoc_TagManager	List of TTag objects (only non-nil).
TTexDocGenerator	PasDoc_GenLatex	LaTeX documentation generator.
TTextReader	PasDoc_ProcessLineTalk	TTextReader reads given Stream line by line.
TToken	PasDoc_Tokenizer	Stores the exact type and additional information on one token.
TTokenizer	PasDoc_Tokenizer	Converts an input TStream to a sequence of TToken objects.
TTokenList	PasDoc_Tokenizer
TTokenType	PasDoc_Tokenizer	All types of tokens.
TTopLevelTag	PasDoc_TagManager
TTranslationID	PasDoc_Languages	All translatable string.
TTryAutoLinkEvent	PasDoc_TagManager
TUpperCaseLetter	PasDoc_Scanner	subrange type that has the 26 lower case letters from a to z
TValueOption	PasDoc_OptionParser	Base class for all options that have values.
TVisibilities	PasDoc_Items
TVisibility	PasDoc_Items	Visibility of a field/method.
UnicodeString	PasDoc_Types
VisibilitiesToStr	PasDoc_Items	Returns VisibilityStr for each value in Visibilities, delimited by commas.
VisibilityStr	PasDoc_Items
VisToStr	PasDoc_Items
WhiteSpace	PasDoc_Utils	Any whitespace (that may indicate newline or not)
WhiteSpaceNL	PasDoc_Utils	Whitespace that is some part of newline.
WhiteSpaceNotNL	PasDoc_Utils	Whitespace that is not any part of newline.

Generated by PasDoc 1.0.2.

PasDoc's autodoc

Overview

All Identifiers