PasDoc's autodoc

Unit PasDoc_Languages

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

Description

PasDoc language definitions and translations.

Overview

Classes, Interfaces, Objects and Records

Name Description
Record TLanguageRecord  
Class TPasDocLanguages Language class to hold all translated strings

Functions and Procedures

function LanguageFromIndex(i: integer): string;
function LanguageFromID(i: TLanguageID): string;
function SyntaxFromIndex(i: integer): string;
function SyntaxFromID(i: TLanguageID): string;
function IDfromLanguage(const s: string): TLanguageID;
function Translation(id: TTranslationID; lang: TLanguageID): string;
function LanguageFromStr(S: string; out LanguageId: TLanguageID): boolean;
function LanguageDescriptor(id: TLanguageID): PLanguageRecord;
function LanguageCode(const Language: TLanguageID): string;

Types

TLanguageID = (...);
TTranslationID = (...);
RTransTable = array[TTranslationID] of string;
PTransTable = ˆRTransTable;
PLanguageRecord = ˆTLanguageRecord;

Constants

DEFAULT_LANGUAGE = lgEnglish;
lgDefault = lgEnglish;

Description

Functions and Procedures

function LanguageFromIndex(i: integer): string;

Full language name

function LanguageFromID(i: TLanguageID): string;
 
function SyntaxFromIndex(i: integer): string;

Language abbreviation

function SyntaxFromID(i: TLanguageID): string;
 
function IDfromLanguage(const s: string): TLanguageID;

Search for language by short or long name

function Translation(id: TTranslationID; lang: TLanguageID): string;

Manual translation of id into lang

function LanguageFromStr(S: string; out LanguageId: TLanguageID): boolean;

Find a language with Syntax = S (case ignored). Returns True and sets LanguageId if found, otherwise returns False.

function LanguageDescriptor(id: TLanguageID): PLanguageRecord;

access LANGUAGE_ARRAY

function LanguageCode(const Language: TLanguageID): string;

Language code, using an official standardardized language names, suitable for Aspell or HTML.

Types

TLanguageID = (...);

An enumeration type of all supported languages

Values
  • lgBosnian
  • lgBrazilian_1252
  • lgBrazilian_utf8
  • lgBulgarian
  • lgCatalan
  • lgChinese_gb2312
  • lgCroatian
  • lgDanish
  • lgDutch
  • lgEnglish
  • lgFrench_ISO_8859_15
  • lgFrench_UTF_8
  • lgGerman_ISO_8859_15
  • lgGerman_UTF_8
  • lgIndonesian
  • lgItalian
  • lgJavanese
  • lgPolish_CP1250
  • lgPolish_ISO_8859_2
  • lgRussian_1251
  • lgRussian_utf8
  • lgRussian_866
  • lgRussian_koi8
  • lgSlovak
  • lgSpanish
  • lgSwedish
  • lgHungarian_1250
  • lgCzech_CP1250
  • lgCzech_ISO_8859_2
TTranslationID = (...);

An enumeration type of all static output texts. Warning: count and order changed!

Values
  • trNoTrans: no translation ID assigned, so far
  • trLanguage: the language name (English, ASCII), e.g. for file names.
  • trUnits: map
  • trClassHierarchy
  • trCio
  • trNestedCR
  • trNestedTypes
  • trIdentifiers
  • trGvUses
  • trGvClasses
  • trClasses: tables and members
  • trClass
  • trDispInterface
  • trInterface
  • trObjects
  • trObject
  • trRecord
  • trPacked
  • trHierarchy
  • trFields
  • trMethods
  • trProperties
  • trLibrary
  • trPackage
  • trProgram
  • trUnit
  • trUses
  • trConstants
  • trFunctionsAndProcedures
  • trTypes
  • trType
  • trVariables
  • trAuthors
  • trAuthor
  • trCreated
  • trLastModified
  • trSubroutine
  • trParameters
  • trReturns
  • trExceptionsRaised
  • trExceptions
  • trException
  • trEnum
  • trVisibility: visibilities
  • trPrivate
  • trStrictPrivate
  • trProtected
  • trStrictProtected
  • trPublic
  • trPublished
  • trAutomated
  • trImplicit
  • trDeprecated: hints
  • trPlatformSpecific
  • trLibrarySpecific
  • trExperimental
  • trOverview: headings
  • trIntroduction
  • trConclusion
  • trAdditionalFile
  • trEnclosingClass
  • trHeadlineCio
  • trHeadlineConstants
  • trHeadlineFunctionsAndProcedures
  • trHeadlineIdentifiers
  • trHeadlineTypes
  • trHeadlineUnits
  • trHeadlineVariables
  • trSummaryCio
  • trDeclaration: column headings
  • trDescription: as column OR section heading!
  • trDescriptions: section heading for detailed descriptions
  • trName
  • trValues
  • trWarningTag: tags with inbuilt heading
  • trNoteTag
  • trNone: empty tables
  • trNoCIOs
  • trNoCIOsForHierarchy
  • trNoTypes
  • trNoVariables
  • trNoConstants
  • trNoFunctions
  • trNoIdentifiers
  • trHelp: misc
  • trLegend
  • trMarker
  • trWarningOverwrite
  • trWarning
  • trGeneratedBy
  • trGeneratedOn
  • trOnDateTime
  • trSearch
  • trSeeAlso
  • trNested
  • trAttributes: add more here
  • trDummy
RTransTable = array[TTranslationID] of string;

array holding the translated strings, or empty for default (English) text.

PTransTable = ˆRTransTable;
 
PLanguageRecord = ˆTLanguageRecord;

language descriptor

Constants

DEFAULT_LANGUAGE = lgEnglish;
 
lgDefault = lgEnglish;
 

Authors

Generated by PasDoc 0.16.0.