All Functions and Procedures

Name Unit Description
CombinePaths PasDoc_Utils

Combines BasePath with RelPath.

COMPILER_NAME PasDoc_Versions

Nice compiler name.

CopyFile PasDoc_Utils

 

DataToFile PasDoc_Utils

 

DeleteFileExt PasDoc_Utils

Remove from the FileName the last extension (including the dot).

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

 

GlueNameParts PasDoc_Types

Simply concatenates all NameParts with dot.

IDfromLanguage PasDoc_Languages

Search for language by short or long name

IsCharInSet PasDoc_Utils

 

IsCharInSet PasDoc_Utils

 

IsEmpty PasDoc_StringVector

 

IsLeadChar PasDoc_Utils

 

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

Checks is Prefix a prefix of S.

IsStrEmptyA PasDoc_Utils

string empty means it contains only whitespace

IsUtf8LeadByte PasDoc_Utils

 

IsUtf8TrailByte PasDoc_Utils

 

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.

LanguageDescriptor PasDoc_Languages

access LANGUAGE_ARRAY

LanguageFromID PasDoc_Languages

 

LanguageFromIndex PasDoc_Languages

Full language name

LanguageFromStr PasDoc_Languages

Find a language with Syntax = S (case ignored).

Main PasDoc_Main

This is the main procedure of PasDoc, it does everything.

MakeMethod PasDoc_Utils

creates a "method pointer"

MethodTypeToString PasDoc_Items

Returns lowercased keyword associated with given method type.

NewStringCardinalTree PasDoc_HierarchyTree

 

NewStringVector PasDoc_StringVector

 

ObjectVectorIsNilOrEmpty PasDoc_ObjectVector

 

OneNamePart PasDoc_Types

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

PASDOC_FULL_INFO PasDoc_Versions

Returns pasdoc name, version, used compiler version, etc.

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.

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

Returns S with all Chars replaced by ReplacementChar

SEnding PasDoc_Utils

SEnding returns S contents starting from position P.

SortSettingFromName PasDoc_SortSettings

 

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).

StandardDirectiveByName PasDoc_Tokenizer

Checks is Name (case ignored) some Pascal keyword.

StrCountCharA PasDoc_Utils

count occurences of AChar in AString

StreamReadLine PasDoc_StreamUtils

 

StreamWriteLine PasDoc_StreamUtils

Write AString contents, then LineEnding to AStream

StreamWriteString PasDoc_StreamUtils

Just write AString contents to AStream

StringReplaceChars PasDoc_Utils

Returns S with each char from ReplacementArray[].cChar replaced with ReplacementArray[].sSpec.

StringToFile PasDoc_Utils

 

StripHtml PasDoc_Utils

Strip HTML elements from the string.

StrPosIA PasDoc_Utils

Position of the ASub in AString.

Swap16Buf PasDoc_Utils

 

SyntaxFromID PasDoc_Languages

 

SyntaxFromIndex PasDoc_Languages

Language abbreviation

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.

Translation PasDoc_Languages

Manual translation of id into lang

Utf8Size PasDoc_Utils

 

VisibilitiesToStr PasDoc_Items

Returns VisibilityStr for each value in Visibilities, delimited by commas.

VisToStr PasDoc_Items

 


Generated by PasDoc 0.16.0.