The `TranslatorEnglish` Class Reference

Declaration

class TranslatorEnglish { ... }

Included Headers

Base class

class	Translator
	Abstract base class for all translatable text fragments. More...

Derived Classes

class	TranslatorJapaneseEn


class	TranslatorKoreanEn

Public Member Functions Index

QCString	idLanguage () override


QCString	latexLanguageSupportCommand () override


QCString	trISOLang () override


QCString	getLanguageString () override
	language codes for Html help More...

QCString	trRelatedFunctions () override


QCString	trRelatedSubscript () override


QCString	trDetailedDescription () override


QCString	trDetails () override


QCString	trMemberTypedefDocumentation () override


QCString	trMemberEnumerationDocumentation () override


QCString	trMemberFunctionDocumentation () override


QCString	trMemberDataDocumentation () override


QCString	trMore () override


QCString	trListOfAllMembers () override


QCString	trMemberList () override


QCString	trThisIsTheListOfAllMembers () override


QCString	trIncludingInheritedMembers () override


QCString	trGeneratedAutomatically (const QCString &s) override


QCString	trEnumName () override


QCString	trEnumValue () override


QCString	trDefinedIn () override


QCString	trModules () override


QCString	trClassHierarchy () override


QCString	trCompoundList () override


QCString	trFileList () override


QCString	trCompoundMembers () override


QCString	trFileMembers () override


QCString	trRelatedPages () override


QCString	trExamples () override


QCString	trSearch () override


QCString	trClassHierarchyDescription () override


QCString	trFileListDescription (bool extractAll) override


QCString	trCompoundListDescription () override


QCString	trCompoundMembersDescription (bool extractAll) override


QCString	trFileMembersDescription (bool extractAll) override


QCString	trExamplesDescription () override


QCString	trRelatedPagesDescription () override


QCString	trModulesDescription () override


QCString	trDocumentation (const QCString &projName) override


QCString	trModuleIndex () override


QCString	trHierarchicalIndex () override


QCString	trCompoundIndex () override


QCString	trFileIndex () override


QCString	trModuleDocumentation () override


QCString	trClassDocumentation () override


QCString	trFileDocumentation () override


QCString	trReferenceManual () override


QCString	trDefines () override


QCString	trTypedefs () override


QCString	trEnumerations () override


QCString	trFunctions () override


QCString	trVariables () override


QCString	trEnumerationValues () override


QCString	trDefineDocumentation () override


QCString	trTypedefDocumentation () override


QCString	trEnumerationTypeDocumentation () override


QCString	trFunctionDocumentation () override


QCString	trVariableDocumentation () override


QCString	trCompounds () override


QCString	trGeneratedAt (const QCString &date, const QCString &projName) override


QCString	trClassDiagram (const QCString &clName) override


QCString	trWarning () override


QCString	trVersion () override


QCString	trDate () override


QCString	trReturns () override


QCString	trSeeAlso () override


QCString	trParameters () override


QCString	trExceptions () override


QCString	trGeneratedBy () override


QCString	trNamespaceList () override


QCString	trNamespaceListDescription (bool extractAll) override


QCString	trFriends () override


QCString	trRelatedFunctionDocumentation () override


QCString	trCompoundReference (const QCString &clName, ClassDef::CompoundType compType, bool isTemplate) override


QCString	trFileReference (const QCString &fileName) override


QCString	trNamespaceReference (const QCString &namespaceName) override


QCString	trPublicMembers () override


QCString	trPublicSlots () override


QCString	trSignals () override


QCString	trStaticPublicMembers () override


QCString	trProtectedMembers () override


QCString	trProtectedSlots () override


QCString	trStaticProtectedMembers () override


QCString	trPrivateMembers () override


QCString	trPrivateSlots () override


QCString	trStaticPrivateMembers () override


QCString	trWriteList (int numEntries) override


QCString	trInheritsList (int numEntries) override


QCString	trInheritedByList (int numEntries) override


QCString	trReimplementedFromList (int numEntries) override


QCString	trReimplementedInList (int numEntries) override


QCString	trNamespaceMembers () override


QCString	trNamespaceMemberDescription (bool extractAll) override


QCString	trNamespaceIndex () override


QCString	trNamespaceDocumentation () override


QCString	trNamespaces () override


QCString	trGeneratedFromFiles (ClassDef::CompoundType compType, bool single) override


QCString	trReturnValues () override


QCString	trMainPage () override


QCString	trPageAbbreviation () override


QCString	trDefinedAtLineInSourceFile () override


QCString	trDefinedInSourceFile () override


QCString	trDeprecated () override


QCString	trCollaborationDiagram (const QCString &clName) override


QCString	trInclDepGraph (const QCString &fName) override


QCString	trConstructorDocumentation () override


QCString	trGotoSourceCode () override


QCString	trGotoDocumentation () override


QCString	trPrecondition () override


QCString	trPostcondition () override


QCString	trInvariant () override


QCString	trInitialValue () override


QCString	trCode () override


QCString	trGraphicalHierarchy () override


QCString	trGotoGraphicalHierarchy () override


QCString	trGotoTextualHierarchy () override


QCString	trPageIndex () override


QCString	trNote () override


QCString	trPublicTypes () override


QCString	trPublicAttribs () override


QCString	trStaticPublicAttribs () override


QCString	trProtectedTypes () override


QCString	trProtectedAttribs () override


QCString	trStaticProtectedAttribs () override


QCString	trPrivateTypes () override


QCString	trPrivateAttribs () override


QCString	trStaticPrivateAttribs () override


QCString	trTodo () override


QCString	trTodoList () override


QCString	trReferencedBy () override


QCString	trRemarks () override


QCString	trAttention () override


QCString	trInclByDepGraph () override


QCString	trSince () override


QCString	trLegendTitle () override


QCString	trLegendDocs () override


QCString	trLegend () override


QCString	trTest () override


QCString	trTestList () override


QCString	trProperties () override


QCString	trPropertyDocumentation () override


QCString	trClasses () override


QCString	trPackage (const QCString &name) override


QCString	trPackageListDescription () override


QCString	trPackages () override


QCString	trDefineValue () override


QCString	trBug () override


QCString	trBugList () override


QCString	trRTFansicp () override


QCString	trRTFCharSet () override


QCString	trRTFGeneralIndex () override


QCString	trClass (bool first_capital, bool singular) override


QCString	trFile (bool first_capital, bool singular) override


QCString	trNamespace (bool first_capital, bool singular) override


QCString	trGroup (bool first_capital, bool singular) override


QCString	trPage (bool first_capital, bool singular) override


QCString	trMember (bool first_capital, bool singular) override


QCString	trGlobal (bool first_capital, bool singular) override


QCString	trAuthor (bool first_capital, bool singular) override


QCString	trReferences () override


QCString	trImplementedFromList (int numEntries) override


QCString	trImplementedInList (int numEntries) override


QCString	trRTFTableOfContents () override


QCString	trDeprecatedList () override


QCString	trEvents () override


QCString	trEventDocumentation () override


QCString	trPackageTypes () override


QCString	trPackageFunctions () override


QCString	trPackageMembers () override


QCString	trStaticPackageFunctions () override


QCString	trPackageAttribs () override


QCString	trStaticPackageAttribs () override


QCString	trAll () override


QCString	trCallGraph () override


QCString	trSearchResultsTitle () override


QCString	trSearchResults (int numDocuments) override


QCString	trSearchMatches () override


QCString	trSourceFile (const QCString &filename) override


QCString	trDirIndex () override


QCString	trDirDocumentation () override


QCString	trDirectories () override


QCString	trDirReference (const QCString &dirName) override


QCString	trDir (bool first_capital, bool singular) override


QCString	trOverloadText () override


QCString	trCallerGraph () override


QCString	trEnumerationValueDocumentation () override


QCString	trMemberFunctionDocumentationFortran () override


QCString	trCompoundListFortran () override


QCString	trCompoundMembersFortran () override


QCString	trCompoundListDescriptionFortran () override


QCString	trCompoundMembersDescriptionFortran (bool extractAll) override


QCString	trCompoundIndexFortran () override


QCString	trTypeDocumentation () override


QCString	trSubprograms () override


QCString	trSubprogramDocumentation () override


QCString	trDataTypes () override


QCString	trModulesList () override


QCString	trModulesListDescription (bool extractAll) override


QCString	trCompoundReferenceFortran (const QCString &clName, ClassDef::CompoundType compType, bool isTemplate) override


QCString	trModuleReference (const QCString &namespaceName) override


QCString	trModulesMembers () override


QCString	trModulesMemberDescription (bool extractAll) override


QCString	trModulesIndex () override


QCString	trModule (bool first_capital, bool singular) override


QCString	trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single) override


QCString	trType (bool first_capital, bool singular) override


QCString	trSubprogram (bool first_capital, bool singular) override


QCString	trTypeConstraints () override


QCString	trDirRelation (const QCString &name) override


QCString	trLoading () override


QCString	trGlobalNamespace () override


QCString	trSearching () override


QCString	trNoMatches () override


QCString	trFileIn (const QCString &name) override


QCString	trIncludesFileIn (const QCString &name) override


QCString	trDateTime (int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime) override
	Compiles a date string. More...

QCString	trDayOfWeek (int dayOfWeek, bool, bool full) override


QCString	trMonth (int month, bool, bool full) override


QCString	trDayPeriod (bool period) override


QCString	trCiteReferences () override


QCString	trCopyright () override


QCString	trDirDepGraph (const QCString &name) override


QCString	trDetailLevel () override


QCString	trTemplateParameters () override


QCString	trAndMore (const QCString &number) override


QCString	trEnumGeneratedFromFiles (bool single) override


QCString	trEnumReference (const QCString &name) override


QCString	trInheritedFrom (const QCString &members, const QCString &what) override


QCString	trAdditionalInheritedMembers () override


QCString	trPanelSynchronisationTooltip (bool enable) override


QCString	trProvidedByCategory () override


QCString	trExtendsClass () override


QCString	trClassMethods () override


QCString	trInstanceMethods () override


QCString	trMethodDocumentation () override


QCString	trInterfaces () override
	old style UNO IDL services: implemented interfaces More...

QCString	trServices () override
	old style UNO IDL services: inherited services More...

QCString	trConstantGroups () override
	UNO IDL constant groups. More...

QCString	trConstantGroupReference (const QCString &namespaceName) override
	UNO IDL constant groups. More...

QCString	trServiceReference (const QCString &sName) override
	UNO IDL service page title. More...

QCString	trSingletonReference (const QCString &sName) override
	UNO IDL singleton page title. More...

QCString	trServiceGeneratedFromFiles (bool single) override
	UNO IDL service page. More...

QCString	trSingletonGeneratedFromFiles (bool single) override
	UNO IDL singleton page. More...

QCString	trDesignUnitHierarchy () override
	VHDL design unit hierarchy. More...

QCString	trDesignUnitList () override
	VHDL design unit list. More...

QCString	trDesignUnitMembers () override
	VHDL design unit members. More...

QCString	trDesignUnitListDescription () override
	VHDL design unit list description. More...

QCString	trDesignUnitIndex () override
	VHDL design unit index. More...

QCString	trDesignUnits () override
	VHDL design units. More...

QCString	trFunctionAndProc () override
	VHDL functions/procedures/processes. More...

QCString	trVhdlType (VhdlSpecifier type, bool single) override
	VHDL type. More...

QCString	trCustomReference (const QCString &name) override


QCString	trConstants () override


QCString	trConstantDocumentation () override


QCString	trSequences () override


QCString	trSequenceDocumentation () override


QCString	trDictionaries () override


QCString	trDictionaryDocumentation () override


QCString	trSliceInterfaces () override


QCString	trInterfaceIndex () override


QCString	trInterfaceList () override


QCString	trInterfaceListDescription () override


QCString	trInterfaceHierarchy () override


QCString	trInterfaceHierarchyDescription () override


QCString	trInterfaceDocumentation () override


QCString	trStructs () override


QCString	trStructIndex () override


QCString	trStructList () override


QCString	trStructListDescription () override


QCString	trStructDocumentation () override


QCString	trExceptionIndex () override


QCString	trExceptionList () override


QCString	trExceptionListDescription () override


QCString	trExceptionHierarchy () override


QCString	trExceptionHierarchyDescription () override


QCString	trExceptionDocumentation () override


QCString	trCompoundReferenceSlice (const QCString &clName, ClassDef::CompoundType compType, bool isLocal) override


QCString	trOperations () override


QCString	trOperationDocumentation () override


QCString	trDataMembers () override


QCString	trDataMemberDocumentation () override


QCString	trDesignUnitDocumentation () override
	VHDL design unit documentation. More...

QCString	trConcept (bool first_capital, bool singular) override
	C++20 concept. More...

QCString	trConceptReference (const QCString &conceptName) override


QCString	trConceptList () override


QCString	trConceptIndex () override


QCString	trConceptDocumentation () override


QCString	trConceptListDescription (bool extractAll) override


QCString	trConceptDefinition () override


QCString	trPackageList () override


QCString	trFlowchart () override


QCString	trRelatedSymbols () override


QCString	trRelatedSymbolsSubscript () override


QCString	trRelatedSymbolDocumentation () override


QCString	trCompoundType (ClassDef::CompoundType compType, SrcLangExt lang) override


QCString	trFileMembersDescriptionTotal (FileMemberHighlight::Enum hl) override


QCString	trCompoundMembersDescriptionTotal (ClassMemberHighlight::Enum hl) override


QCString	trNamespaceMembersDescriptionTotal (NamespaceMemberHighlight::Enum hl) override


QCString	trDefinition () override


QCString	trDeclaration () override


QCString	trTopics () override


QCString	trTopicDocumentation () override


QCString	trTopicList () override


QCString	trTopicIndex () override


QCString	trTopicListDescription () override


QCString	trModuleMembersDescriptionTotal (ModuleMemberHighlight::Enum hl) override


QCString	trExportedModules () override


QCString	trCopyToClipboard () override


QCString	trImportant () override

Description

When defining a translator class for the new language, follow the description in the documentation. One of the steps says that you should copy the translator_en.h (this) file to your translator_xx.h new file. Your new language should use the Translator class as the base class. This means that you need to implement exactly the same (pure virtual) override methods as the TranslatorEnglish does. Because of this, it is a good idea to start with the copy of TranslatorEnglish and replace the strings one by one.

It is not necessary to include "translator.h" or "translator_adapter.h" here. The files are included in the language.cpp correctly. Not including any of the mentioned files frees the maintainer from thinking about whether the first, the second, or both files should be included or not, and why. This holds namely for localized translators because their base class is changed occasionally to adapter classes when the Translator class changes the interface, or back to the Translator class (by the local maintainer) when the localized translator is made up-to-date again.

Definition at line 43 of file translator_en.h.

Public Member Functions

getLanguageString()

QCString TranslatorEnglish::getLanguageString ()

inline virtual

language codes for Html help

 0x402 Bulgarian
 0x405 Czech
 0x406 Danish
 0x413 Dutch
 0xC09 English (Australia)
 0x809 English (Britain)
 0x1009 English (Canada)
 0x1809 English (Ireland)
 0x1409 English (New Zealand)
 0x1C09 English (South Africa)
 0x409 English (United States)
 0x40B Finnish
 0x40C French
 0x407 German
 0x408 Greece
 0x439 Hindi
 0x40E Hungarian
 0x410 Italian
 0x814 Norwegian
 0x415 Polish
 0x816 Portuguese(Portugal)
 0x416 Portuguese(Brazil)
 0x419 Russian
 0x80A Spanish(Mexico)
 0xC0A Spanish(Modern Sort)
 0x40A Spanish(Traditional Sort)
 0x41D Swedish
 0x41F Turkey
 0x411 Japanese
 0x412 Korean
 0x804 Chinese (PRC)
 0x404 Chinese (Taiwan)

New LCIDs:

 0x421 Indonesian
 0x41A Croatian
 0x418 Romanian
 0x424 Slovenian
 0x41B Slovak
 0x422 Ukrainian
 0x81A Serbian (Serbia, Latin)
 0x403 Catalan
 0x426 Latvian
 0x427 Lithuanian
 0x436 Afrikaans
 0x42A Vietnamese
 0x429 Persian (Iran)
 0xC01 Arabic (Egypt) - I don't know which version of arabic is used inside translator_ar.h ,
       so I have chosen Egypt at random

Code for Esperanto should be as shown below but the htmlhelp compiler 1.3 does not support this (and no newer version is available).

0x48f Esperanto

So do a fallback to the default language

0x409 English (United States)

0xC1A Serbian (Serbia, Cyrillic)

Definition at line 82 of file translator_en.h.

82 QCString getLanguageString() override

83 {

84 return "0x409 English (United States)";

85 }

idLanguage()

QCString TranslatorEnglish::idLanguage ()

inline virtual

Used for identification of the language. The identification should not be translated. It should be replaced by the name of the language in English using lower-case characters only (e.g. "czech", "japanese", "russian", etc.). It should be equal to the identification used in language.cpp.

Definition at line 55 of file translator_en.h.

55 QCString idLanguage() override

56 { return "english"; }

latexLanguageSupportCommand()

QCString TranslatorEnglish::latexLanguageSupportCommand ()

inline virtual

Used to get the LaTeX command(s) for the language support. This method should return string with commands that switch LaTeX to the desired language. For example

"\\usepackage[german]{babel}\n"

"\\usepackage{polski}\n"
 "\\usepackage[latin2]{inputenc}\n"
 "\\usepackage[T1]{fontenc}\n"

The English LaTeX does not use such commands. Because of this the empty string is returned in this implementation.

Definition at line 72 of file translator_en.h.

72 QCString latexLanguageSupportCommand() override

73 {

74 return "";

75 }

trAdditionalInheritedMembers()

QCString TranslatorEnglish::trAdditionalInheritedMembers ()

inline virtual

Header of the sections with inherited members specific for the base class(es)

Definition at line 1883 of file translator_en.h.

1883 QCString trAdditionalInheritedMembers() override

1884 { return "Additional Inherited Members"; }

trAll()

QCString TranslatorEnglish::trAll ()

inline virtual

Used in the quick index of a class/file/namespace member list page to link to the unfiltered list of all members.

Definition at line 1401 of file translator_en.h.

1401 QCString trAll() override

1402 {

1403 return "All";

1404 }

trAndMore()

QCString TranslatorEnglish::trAndMore (const QCString & number)

inline virtual

Used in dot graph when UML_LOOK is enabled and there are many fields

Definition at line 1861 of file translator_en.h.

1861 QCString trAndMore(const QCString &number) override

1862 { return "and "+number+" more..."; }

trAttention()

QCString TranslatorEnglish::trAttention ()

inline virtual

Definition at line 978 of file translator_en.h.

978 QCString trAttention() override

979 {

980 return "Attention";

981 }

trAuthor()

QCString TranslatorEnglish::trAuthor (bool first_capital, bool singular)

inline virtual

This text is generated when the \author command is used and for the author section in man pages.

Definition at line 1274 of file translator_en.h.

1274 QCString trAuthor(bool first_capital, bool singular) override

1275 {

1276 return createNoun(first_capital, singular, "author", "s");

1277 }

Reference Translator::createNoun.

trBug()

QCString TranslatorEnglish::trBug ()

inline virtual

Used as a marker that is put before a \bug item

Definition at line 1146 of file translator_en.h.

1146 QCString trBug() override

1147 {

1148 return "Bug";

1149 }

trBugList()

QCString TranslatorEnglish::trBugList ()

inline virtual

Used as the header of the bug list

Definition at line 1151 of file translator_en.h.

1151 QCString trBugList() override

1152 {

1153 return "Bug List";

1154 }

trCallerGraph()

QCString TranslatorEnglish::trCallerGraph ()

inline virtual

This is used to introduce a caller (or called-by) graph

Definition at line 1520 of file translator_en.h.

1520 QCString trCallerGraph() override

1521 {

1522 return "Here is the caller graph for this function:";

1523 }

trCallGraph()

QCString TranslatorEnglish::trCallGraph ()

inline virtual

Put in front of the call graph for a function.

Definition at line 1406 of file translator_en.h.

1406 QCString trCallGraph() override

1407 {

1408 return "Here is the call graph for this function:";

1409 }

trCiteReferences()

QCString TranslatorEnglish::trCiteReferences ()

inline virtual

Header for the page with bibliographic citations

Definition at line 1837 of file translator_en.h.

1837 QCString trCiteReferences() override

1838 { return "Bibliography"; }

trClass()

QCString TranslatorEnglish::trClass (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1209 of file translator_en.h.

1209 QCString trClass(bool first_capital, bool singular) override

1210 {

1211 return createNoun(first_capital, singular, "class", "es");

1212 }

Reference Translator::createNoun.

Referenced by trCompoundType.

trClassDiagram()

QCString TranslatorEnglish::trClassDiagram (const QCString & clName)

inline virtual

this text is put before a class diagram

Definition at line 532 of file translator_en.h.

532 QCString trClassDiagram(const QCString &clName) override

533 {

534 return "Inheritance diagram for "+clName+":";

535 }

trClassDocumentation()

QCString TranslatorEnglish::trClassDocumentation ()

inline virtual

This is used in LaTeX as the title of the chapter containing the documentation of all classes, structs and unions.

Definition at line 413 of file translator_en.h.

413 QCString trClassDocumentation() override

414 {

415 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

416 {

417 return "Data Structure Documentation";

418 }

419 else if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))

420 {

421 return trDesignUnitDocumentation();

422 }

423 else

424 {

425 return "Class Documentation";

426 }

427 }

References Config_getBool and trDesignUnitDocumentation.

trClasses()

QCString TranslatorEnglish::trClasses ()

inline virtual

Used for Java classes in the summary section of Java packages

Definition at line 1109 of file translator_en.h.

1109 QCString trClasses() override

1110 {

1111 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

1112 {

1113 return "Data Structures";

1114 }

1115 else

1116 {

1117 return "Classes";

1118 }

1119 }

Reference Config_getBool.

trClassHierarchy()

QCString TranslatorEnglish::trClassHierarchy ()

inline virtual

This is put above each page as a link to the class hierarchy

Definition at line 189 of file translator_en.h.

189 QCString trClassHierarchy() override

190 { return "Class Hierarchy"; }

trClassHierarchyDescription()

QCString TranslatorEnglish::trClassHierarchyDescription ()

inline virtual

This is an introduction to the class hierarchy.

Definition at line 248 of file translator_en.h.

248 QCString trClassHierarchyDescription() override

249 {

250 if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))

251 {

252 return "Here is a hierarchical list of all entities:";

253 }

254 else

255 {

256 return "This inheritance list is sorted roughly, "

257 "but not completely, alphabetically:";

258 }

259 }

Reference Config_getBool.

trClassMethods()

QCString TranslatorEnglish::trClassMethods ()

inline virtual

Used as the header of a list of class methods in Objective-C. These are similar to static public member functions in C++.

Definition at line 1921 of file translator_en.h.

1921 QCString trClassMethods() override

1922 {

1923 return "Class Methods";

1924 }

trCode()

QCString TranslatorEnglish::trCode ()

inline virtual

Text used the source code in the file index

Definition at line 878 of file translator_en.h.

878 QCString trCode() override

879 {

880 return "code";

881 }

trCollaborationDiagram()

QCString TranslatorEnglish::trCollaborationDiagram (const QCString & clName)

inline virtual

this text is put before a collaboration diagram

Definition at line 833 of file translator_en.h.

833 QCString trCollaborationDiagram(const QCString &clName) override

834 {

835 return "Collaboration diagram for "+clName+":";

836 }

trCompoundIndex()

QCString TranslatorEnglish::trCompoundIndex ()

inline virtual

This is used in LaTeX as the title of the chapter with the annotated compound index.

Definition at line 386 of file translator_en.h.

386 QCString trCompoundIndex() override

387 {

388 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

389 {

390 return "Data Structure Index";

391 }

392 else

393 {

394 return "Class Index";

395 }

396 }

Reference Config_getBool.

trCompoundIndexFortran()

QCString TranslatorEnglish::trCompoundIndexFortran ()

inline virtual

This is used in LaTeX as the title of the chapter with the annotated compound index (Fortran).

Definition at line 1575 of file translator_en.h.

1575 QCString trCompoundIndexFortran() override

1576 { return "Data Type Index"; }

trCompoundList()

QCString TranslatorEnglish::trCompoundList ()

inline virtual

This is put above each page as a link to the list of annotated classes

Definition at line 193 of file translator_en.h.

193 QCString trCompoundList() override

194 {

195 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

196 {

197 return "Data Structures";

198 }

199 else

200 {

201 return "Class List";

202 }

203 }

Reference Config_getBool.

trCompoundListDescription()

QCString TranslatorEnglish::trCompoundListDescription ()

inline virtual

This is an introduction to the annotated compound list.

Definition at line 271 of file translator_en.h.

271 QCString trCompoundListDescription() override

272 {

273

274 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

275 {

276 return "Here are the data structures with brief descriptions:";

277 }

278 else if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))

279 {

280 return "Here are the classes with brief descriptions:";

281 }

282 else

283 {

284 return "Here are the classes, structs, "

285 "unions and interfaces with brief descriptions:";

286 }

287 }

Reference Config_getBool.

trCompoundListDescriptionFortran()

QCString TranslatorEnglish::trCompoundListDescriptionFortran ()

inline virtual

This is an introduction to the annotated compound list (Fortran).

Definition at line 1548 of file translator_en.h.

1548 QCString trCompoundListDescriptionFortran() override

1549 { return "Here are the data types with brief descriptions:"; }

trCompoundListFortran()

QCString TranslatorEnglish::trCompoundListFortran ()

inline virtual

This is put above each page as a link to the list of annotated data types (Fortran).

Definition at line 1540 of file translator_en.h.

1540 QCString trCompoundListFortran() override

1541 { return "Data Types List"; }

trCompoundMembers()

QCString TranslatorEnglish::trCompoundMembers ()

inline virtual

This is put above each page as a link to all members of compounds.

Definition at line 210 of file translator_en.h.

210 QCString trCompoundMembers() override

211 {

212 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

213 {

214 return "Data Fields";

215 }

216 else

217 {

218 return "Class Members";

219 }

220 }

Reference Config_getBool.

trCompoundMembersDescription()

QCString TranslatorEnglish::trCompoundMembersDescription (bool extractAll)

inline virtual

This is an introduction to the page with all class members.

Definition at line 290 of file translator_en.h.

290 QCString trCompoundMembersDescription(bool extractAll) override

291 {

292 QCString result="Here is a list of all ";

293 if (!extractAll)

294 {

295 result+="documented ";

296 }

297 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

298 {

299 result+="struct and union fields";

300 }

301 else

302 {

303 result+="class members";

304 }

305 result+=" with links to ";

306 if (!extractAll)

307 {

308 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

309 {

310 result+="the struct/union documentation for each field:";

311 }

312 else

313 {

314 result+="the class documentation for each member:";

315 }

316 }

317 else

318 {

319 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

320 {

321 result+="the structures/unions they belong to:";

322 }

323 else

324 {

325 result+="the classes they belong to:";

326 }

327 }

328 return result;

329 }

Reference Config_getBool.

trCompoundMembersDescriptionFortran()

QCString TranslatorEnglish::trCompoundMembersDescriptionFortran (bool extractAll)

inline virtual

This is an introduction to the page with all data types (Fortran).

Definition at line 1552 of file translator_en.h.

1552 QCString trCompoundMembersDescriptionFortran(bool extractAll) override

1553 {

1554 QCString result="Here is a list of all ";

1555 if (!extractAll)

1556 {

1557 result+="documented ";

1558 }

1559 result+="data types members";

1560 result+=" with links to ";

1561 if (!extractAll)

1562 {

1563 result+="the data structure documentation for each member";

1564 }

1565 else

1566 {

1567 result+="the data types they belong to:";

1568 }

1569 return result;

1570 }

trCompoundMembersDescriptionTotal()

QCString TranslatorEnglish::trCompoundMembersDescriptionTotal (ClassMemberHighlight::Enum hl)

inline virtual

Definition at line 2420 of file translator_en.h.

2420 QCString trCompoundMembersDescriptionTotal(ClassMemberHighlight::Enum hl) override

2421 {

2422 bool extractAll = Config_getBool(EXTRACT_ALL);

2423 QCString result="Here is a list of all ";

2424 if (!extractAll)

2425 {

2426 result+="documented ";

2427 }

2428

2429 switch (hl)

2430 {

2431 case ClassMemberHighlight::All:

2432 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

2433 {

2434 result+="struct and union fields";

2435 }

2436 else

2437 {

2438 result+="class members";

2439 }

2440 break;

2441 case ClassMemberHighlight::Functions:

2442 result+="functions";

2443 break;

2444 case ClassMemberHighlight::Variables:

2445 result+="variables";

2446 break;

2447 case ClassMemberHighlight::Typedefs:

2448 result+="typedefs";

2449 break;

2450 case ClassMemberHighlight::Enums:

2451 result+="enums";

2452 break;

2453 case ClassMemberHighlight::EnumValues:

2454 result+="enum values";

2455 break;

2456 case ClassMemberHighlight::Properties:

2457 result+="properties";

2458 break;

2459 case ClassMemberHighlight::Events:

2460 result+="events";

2461 break;

2462 case ClassMemberHighlight::Related:

2463 result+="related symbols";

2464 break;

2465 case ClassMemberHighlight::Total: // for completeness

2466 break;

2467 }

2468 result+=" with links to ";

2469 if (!extractAll)

2470 {

2471 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

2472 {

2473 result+="the struct/union documentation for each field:";

2474 }

2475 else

2476 {

2477 result+="the class documentation for each member:";

2478 }

2479 }

2480 else

2481 {

2482 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

2483 {

2484 result+="the structures/unions they belong to:";

2485 }

2486 else

2487 {

2488 result+="the classes they belong to:";

2489 }

2490 }

2491 return result;

2492 }

References ClassMemberHighlight::All, Config_getBool, ClassMemberHighlight::Enums, ClassMemberHighlight::EnumValues, ClassMemberHighlight::Events, ClassMemberHighlight::Functions, ClassMemberHighlight::Properties, ClassMemberHighlight::Related, ClassMemberHighlight::Total, ClassMemberHighlight::Typedefs and ClassMemberHighlight::Variables.

trCompoundMembersFortran()

QCString TranslatorEnglish::trCompoundMembersFortran ()

inline virtual

This is put above each page as a link to all members of compounds (Fortran).

Definition at line 1544 of file translator_en.h.

1544 QCString trCompoundMembersFortran() override

1545 { return "Data Fields"; }

trCompoundReference()

QCString TranslatorEnglish::trCompoundReference (const QCString & clName, ClassDef::CompoundType compType, bool isTemplate)

inline virtual

used as the title of the HTML page of a class/struct/union

Definition at line 607 of file translator_en.h.

607 QCString trCompoundReference(const QCString &clName,

608 ClassDef::CompoundType compType,

609 bool isTemplate) override

610 {

611 QCString result=clName;

612 switch(compType)

613 {

614 case ClassDef::Class: result+=" Class"; break;

615 case ClassDef::Struct: result+=" Struct"; break;

616 case ClassDef::Union: result+=" Union"; break;

617 case ClassDef::Interface: result+=" Interface"; break;

618 case ClassDef::Protocol: result+=" Protocol"; break;

619 case ClassDef::Category: result+=" Category"; break;

620 case ClassDef::Exception: result+=" Exception"; break;

621 default: break;

622 }

623 if (isTemplate) result+=" Template";

624 result+=" Reference";

625 return result;

626 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct and ClassDef::Union.

trCompoundReferenceFortran()

QCString TranslatorEnglish::trCompoundReferenceFortran (const QCString & clName, ClassDef::CompoundType compType, bool isTemplate)

inline virtual

used as the title of the HTML page of a module/type (Fortran)

Definition at line 1616 of file translator_en.h.

1616 QCString trCompoundReferenceFortran(const QCString &clName,

1617 ClassDef::CompoundType compType,

1618 bool isTemplate) override

1619 {

1620 QCString result=clName;

1621 switch(compType)

1622 {

1623 case ClassDef::Class: result+=" Module"; break;

1624 case ClassDef::Struct: result+=" Type"; break;

1625 case ClassDef::Union: result+=" Union"; break;

1626 case ClassDef::Interface: result+=" Interface"; break;

1627 case ClassDef::Protocol: result+=" Protocol"; break;

1628 case ClassDef::Category: result+=" Category"; break;

1629 case ClassDef::Exception: result+=" Exception"; break;

1630 default: break;

1631 }

1632 if (isTemplate) result+=" Template";

1633 result+=" Reference";

1634 return result;

1635 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct and ClassDef::Union.

trCompoundReferenceSlice()

QCString TranslatorEnglish::trCompoundReferenceSlice (const QCString & clName, ClassDef::CompoundType compType, bool isLocal)

inline virtual

Definition at line 2211 of file translator_en.h.

2211 QCString trCompoundReferenceSlice(const QCString &clName, ClassDef::CompoundType compType, bool isLocal) override

2212 {

2213 QCString result=clName;

2214 if (isLocal) result+=" Local";

2215 switch(compType)

2216 {

2217 case ClassDef::Class: result+=" Class"; break;

2218 case ClassDef::Struct: result+=" Struct"; break;

2219 case ClassDef::Union: result+=" Union"; break;

2220 case ClassDef::Interface: result+=" Interface"; break;

2221 case ClassDef::Protocol: result+=" Protocol"; break;

2222 case ClassDef::Category: result+=" Category"; break;

2223 case ClassDef::Exception: result+=" Exception"; break;

2224 default: break;

2225 }

2226 result+=" Reference";

2227 return result;

2228 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct and ClassDef::Union.

trCompounds()

QCString TranslatorEnglish::trCompounds ()

inline virtual

This is used in the documentation of a file/namespace/group before the list of links to documented compounds

Definition at line 508 of file translator_en.h.

508 QCString trCompounds() override

509 {

510 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

511 {

512 return "Data Structures";

513 }

514 else

515 {

516 return "Classes";

517 }

518 }

Reference Config_getBool.

trCompoundType()

QCString TranslatorEnglish::trCompoundType (ClassDef::CompoundType compType, SrcLangExt lang)

inline virtual

the compound type as used for the xrefitems

Definition at line 2346 of file translator_en.h.

2346 QCString trCompoundType(ClassDef::CompoundType compType, SrcLangExt lang) override

2347 {

2348 QCString result;

2349 switch(compType)

2350 {

2351 case ClassDef::Class:

2352 if (lang == SrcLangExt::Fortran) trType(true,true);

2353 else result=trClass(true,true);

2354 break;

2355 case ClassDef::Struct: result="Struct"; break;

2356 case ClassDef::Union: result="Union"; break;

2357 case ClassDef::Interface: result="Interface"; break;

2358 case ClassDef::Protocol: result="Protocol"; break;

2359 case ClassDef::Category: result="Category"; break;

2360 case ClassDef::Exception: result="Exception"; break;

2361 case ClassDef::Service: result="Service"; break;

2362 case ClassDef::Singleton: result="Singleton"; break;

2363 default: break;

2364 }

2365 return result;

2366 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Service, ClassDef::Singleton, ClassDef::Struct, trClass, trType and ClassDef::Union.

trConcept()

QCString TranslatorEnglish::trConcept (bool first_capital, bool singular)

inline virtual

C++20 concept.

Definition at line 2259 of file translator_en.h.

2259 QCString trConcept(bool first_capital, bool singular) override

2260 {

2261 return createNoun(first_capital, singular, "concept", "s");

2262 }

Reference Translator::createNoun.

trConceptDefinition()

QCString TranslatorEnglish::trConceptDefinition ()

inline virtual

used to introduce the definition of the C++20 concept

Definition at line 2293 of file translator_en.h.

2293 QCString trConceptDefinition() override

2294 {

2295 return "Concept definition";

2296 }

trConceptDocumentation()

QCString TranslatorEnglish::trConceptDocumentation ()

inline virtual

used as the title of chapter containing all information about concepts.

Definition at line 2280 of file translator_en.h.

2280 QCString trConceptDocumentation() override

2281 { return "Concept Documentation"; }

trConceptIndex()

QCString TranslatorEnglish::trConceptIndex ()

inline virtual

used as the title of chapter containing the index listing all concepts.

Definition at line 2276 of file translator_en.h.

2276 QCString trConceptIndex() override

2277 { return "Concept Index"; }

trConceptList()

QCString TranslatorEnglish::trConceptList ()

inline virtual

used as the title of page containing all the index of all concepts.

Definition at line 2272 of file translator_en.h.

2272 QCString trConceptList() override

2273 { return "Concept List"; }

trConceptListDescription()

QCString TranslatorEnglish::trConceptListDescription (bool extractAll)

inline virtual

used as an introduction to the concept list

Definition at line 2284 of file translator_en.h.

2284 QCString trConceptListDescription(bool extractAll) override

2285 {

2286 QCString result="Here is a list of all ";

2287 if (!extractAll) result+="documented ";

2288 result+="concepts with brief descriptions:";

2289 return result;

2290 }

trConceptReference()

QCString TranslatorEnglish::trConceptReference (const QCString & conceptName)

inline virtual

used as the title of the HTML page of a C++20 concept page

Definition at line 2264 of file translator_en.h.

2264 QCString trConceptReference(const QCString &conceptName) override

2265 {

2266 QCString result=conceptName;

2267 result+=" Concept Reference";

2268 return result;

2269 }

trConstantDocumentation()

QCString TranslatorEnglish::trConstantDocumentation ()

inline virtual

Definition at line 2119 of file translator_en.h.

2119 QCString trConstantDocumentation() override

2120 {

2121 return "Constant Documentation";

2122 }

trConstantGroupReference()

QCString TranslatorEnglish::trConstantGroupReference (const QCString & namespaceName)

inline virtual

UNO IDL constant groups.

Definition at line 1958 of file translator_en.h.

1958 QCString trConstantGroupReference(const QCString &namespaceName) override

1959 {

1960 QCString result=namespaceName;

1961 result+=" Constant Group Reference";

1962 return result;

1963 }

trConstantGroups()

QCString TranslatorEnglish::trConstantGroups ()

inline virtual

UNO IDL constant groups.

Definition at line 1954 of file translator_en.h.

1954 QCString trConstantGroups() override

1955 { return "Constant Groups"; }

trConstants()

QCString TranslatorEnglish::trConstants ()

inline virtual

Definition at line 2115 of file translator_en.h.

2115 QCString trConstants() override

2116 {

2117 return "Constants";

2118 }

trConstructorDocumentation()

QCString TranslatorEnglish::trConstructorDocumentation ()

inline virtual

header that is put before the list of constructor/destructors.

Definition at line 843 of file translator_en.h.

843 QCString trConstructorDocumentation() override

844 {

845 return "Constructor & Destructor Documentation";

846 }

trCopyright()

QCString TranslatorEnglish::trCopyright ()

inline virtual

Text for copyright paragraph

Definition at line 1841 of file translator_en.h.

1841 QCString trCopyright() override

1842 { return "Copyright"; }

trCopyToClipboard()

QCString TranslatorEnglish::trCopyToClipboard ()

inline virtual

Definition at line 2604 of file translator_en.h.

2604 QCString trCopyToClipboard() override

2605 {

2606 return "Copy to clipboard";

2607 }

trCustomReference()

QCString TranslatorEnglish::trCustomReference (const QCString & name)

inline virtual

Definition at line 2111 of file translator_en.h.

2111 QCString trCustomReference(const QCString &name) override

2112 { return name+" Reference"; }

trDataMemberDocumentation()

QCString TranslatorEnglish::trDataMemberDocumentation ()

inline virtual

Definition at line 2241 of file translator_en.h.

2241 QCString trDataMemberDocumentation() override

2242 {

2243 return "Data Member Documentation";

2244 }

trDataMembers()

QCString TranslatorEnglish::trDataMembers ()

inline virtual

Definition at line 2237 of file translator_en.h.

2237 QCString trDataMembers() override

2238 {

2239 return "Data Members";

2240 }

trDataTypes()

QCString TranslatorEnglish::trDataTypes ()

inline virtual

This is used in the documentation of a file/namespace/group before the list of links to documented compounds (Fortran)

Definition at line 1599 of file translator_en.h.

1599 QCString trDataTypes() override

1600 { return "Data Types"; }

trDate()

QCString TranslatorEnglish::trDate ()

inline virtual

this text is generated when the \date command is used.

Definition at line 546 of file translator_en.h.

546 QCString trDate() override

547 { return "Date"; }

trDateTime()

QCString TranslatorEnglish::trDateTime (int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime)

inline virtual

Compiles a date string.

Parameters

year	Year in 4 digits
month	Month of the year: 1=January
day	Day of the Month: 1..31
dayOfWeek	Day of the week: 1=Monday..7=Sunday
hour	Hour of the day: 0..23
minutes	Minutes in the hour: 0..59
seconds	Seconds within the minute: 0..59
includeTime	Include time in the result string?

Definition at line 1794 of file translator_en.h.

1794 QCString trDateTime(int year,int month,int day,int dayOfWeek,

1795 int hour,int minutes,int seconds,

1796 DateTimeType includeTime) override

1797 {

1798 static const char *days[] = { "Mon","Tue","Wed","Thu","Fri","Sat","Sun" };

1799 static const char *months[] = { "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec" };

1800 QCString sdate;

1801 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Date)

1802 {

1803 sdate.sprintf("%s %s %d %d",days[dayOfWeek-1],months[month-1],day,year);

1804 }

1805 if (includeTime == DateTimeType::DateTime) sdate += " ";

1806 if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Time)

1807 {

1808 QCString stime;

1809 stime.sprintf("%.2d:%.2d:%.2d",hour,minutes,seconds);

1810 sdate+=stime;

1811 }

1812 return sdate;

1813 }

References Date, DateTime, QCString::sprintf and Time.

trDayOfWeek()

QCString TranslatorEnglish::trDayOfWeek (int dayOfWeek, bool, bool full)

inline virtual

Definition at line 1814 of file translator_en.h.

1814 QCString trDayOfWeek(int dayOfWeek, bool, bool full) override

1815 {

1816 static const char *days_short[] = { "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" };

1817 static const char *days_full[] = { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" };

1818 return full? days_full[dayOfWeek-1] : days_short[dayOfWeek-1];

1819 }

trDayPeriod()

QCString TranslatorEnglish::trDayPeriod (bool period)

inline virtual

Definition at line 1826 of file translator_en.h.

1826 QCString trDayPeriod(bool period) override

1827 {

1828 static const char *dayPeriod[] = { "AM", "PM" };

1829 return dayPeriod[period?1:0];

1830 }

trDeclaration()

QCString TranslatorEnglish::trDeclaration ()

inline virtual

Definition at line 2540 of file translator_en.h.

2540 QCString trDeclaration() override { return "Declaration";}

trDefinedAtLineInSourceFile()

QCString TranslatorEnglish::trDefinedAtLineInSourceFile ()

inline virtual

Definition at line 810 of file translator_en.h.

810 QCString trDefinedAtLineInSourceFile() override

811 {

812 return "Definition at line @0 of file @1.";

813 }

trDefinedIn()

QCString TranslatorEnglish::trDefinedIn ()

inline virtual

put after an undocumented member in the list of all members

Definition at line 177 of file translator_en.h.

177 QCString trDefinedIn() override

178 { return "defined in"; }

trDefinedInSourceFile()

QCString TranslatorEnglish::trDefinedInSourceFile ()

inline virtual

Definition at line 814 of file translator_en.h.

814 QCString trDefinedInSourceFile() override

815 {

816 return "Definition in file @0.";

817 }

trDefineDocumentation()

QCString TranslatorEnglish::trDefineDocumentation ()

inline virtual

This is used in the documentation of a file before the list of documentation blocks for defines

Definition at line 478 of file translator_en.h.

478 QCString trDefineDocumentation() override

479 { return "Macro Definition Documentation"; }

trDefines()

QCString TranslatorEnglish::trDefines ()

inline virtual

This is used in the documentation of a file as a header before the list of defines

Definition at line 442 of file translator_en.h.

442 QCString trDefines() override

443 { return "Macros"; }

trDefineValue()

QCString TranslatorEnglish::trDefineValue ()

inline virtual

Text shown before a multi-line define

Definition at line 1136 of file translator_en.h.

1136 QCString trDefineValue() override

1137 {

1138 return "Value:";

1139 }

trDefinition()

QCString TranslatorEnglish::trDefinition ()

inline virtual

Definition at line 2539 of file translator_en.h.

2539 QCString trDefinition() override { return "Definition";}

trDeprecated()

QCString TranslatorEnglish::trDeprecated ()

inline virtual

Definition at line 823 of file translator_en.h.

823 QCString trDeprecated() override

824 {

825 return "Deprecated";

826 }

trDeprecatedList()

QCString TranslatorEnglish::trDeprecatedList ()

inline virtual

Used as the header of the list of item that have been flagged deprecated

Definition at line 1329 of file translator_en.h.

1329 QCString trDeprecatedList() override

1330 {

1331 return "Deprecated List";

1332 }

trDesignUnitDocumentation()

QCString TranslatorEnglish::trDesignUnitDocumentation ()

inline virtual

VHDL design unit documentation.

Definition at line 2251 of file translator_en.h.

2251 QCString trDesignUnitDocumentation() override

2252 { return "Design Unit Documentation"; }

Referenced by trClassDocumentation.

trDesignUnitHierarchy()

QCString TranslatorEnglish::trDesignUnitHierarchy ()

inline virtual

VHDL design unit hierarchy.

Definition at line 2002 of file translator_en.h.

2002 QCString trDesignUnitHierarchy() override

2003 { return "Design Unit Hierarchy"; }

trDesignUnitIndex()

QCString TranslatorEnglish::trDesignUnitIndex ()

inline virtual

VHDL design unit index.

Definition at line 2017 of file translator_en.h.

2017 QCString trDesignUnitIndex() override

2018 { return "Design Unit Index"; }

trDesignUnitList()

QCString TranslatorEnglish::trDesignUnitList ()

inline virtual

VHDL design unit list.

Definition at line 2005 of file translator_en.h.

2005 QCString trDesignUnitList() override

2006 { return "Design Unit List"; }

trDesignUnitListDescription()

QCString TranslatorEnglish::trDesignUnitListDescription ()

inline virtual

VHDL design unit list description.

Definition at line 2011 of file translator_en.h.

2011 QCString trDesignUnitListDescription() override

2012 {

2013 return "Here is a list of all design unit members with links to "

2014 "the Entities they belong to:";

2015 }

trDesignUnitMembers()

QCString TranslatorEnglish::trDesignUnitMembers ()

inline virtual

VHDL design unit members.

Definition at line 2008 of file translator_en.h.

2008 QCString trDesignUnitMembers() override

2009 { return "Design Unit Members"; }

trDesignUnits()

QCString TranslatorEnglish::trDesignUnits ()

inline virtual

VHDL design units.

Definition at line 2020 of file translator_en.h.

2020 QCString trDesignUnits() override

2021 { return "Design Units"; }

trDetailedDescription()

QCString TranslatorEnglish::trDetailedDescription ()

inline virtual

header that is put before the detailed description of files, classes and namespaces.

Definition at line 97 of file translator_en.h.

97 QCString trDetailedDescription() override

98 { return "Detailed Description"; }

trDetailLevel()

QCString TranslatorEnglish::trDetailLevel ()

inline virtual

Detail level selector shown for hierarchical indices

Definition at line 1853 of file translator_en.h.

1853 QCString trDetailLevel() override

1854 { return "detail level"; }

trDetails()

QCString TranslatorEnglish::trDetails ()

inline virtual

header that is used when the summary tag is missing inside the details tag

Definition at line 101 of file translator_en.h.

101 QCString trDetails() override

102 { return "Details"; }

trDictionaries()

QCString TranslatorEnglish::trDictionaries ()

inline virtual

Definition at line 2131 of file translator_en.h.

2131 QCString trDictionaries() override

2132 {

2133 return "Dictionaries";

2134 }

trDictionaryDocumentation()

QCString TranslatorEnglish::trDictionaryDocumentation ()

inline virtual

Definition at line 2135 of file translator_en.h.

2135 QCString trDictionaryDocumentation() override

2136 {

2137 return "Dictionary Documentation";

2138 }

trDir()

QCString TranslatorEnglish::trDir (bool first_capital, bool singular)

inline virtual

This returns the word directory with or without starting capital (first_capital) and in singular or plural form (singular).

Definition at line 1496 of file translator_en.h.

1496 QCString trDir(bool first_capital, bool singular) override

1497 {

1498 return createNoun(first_capital, singular, "director", "ies", "y");

1499 }

Reference Translator::createNoun.

trDirDepGraph()

QCString TranslatorEnglish::trDirDepGraph (const QCString & name)

inline virtual

Header for the graph showing the directory dependencies

Definition at line 1845 of file translator_en.h.

1845 QCString trDirDepGraph(const QCString &name) override

1846 { return "Directory dependency graph for "+name+":"; }

trDirDocumentation()

QCString TranslatorEnglish::trDirDocumentation ()

inline virtual

This is used as the name of the chapter containing the documentation of the directories.

Definition at line 1478 of file translator_en.h.

1478 QCString trDirDocumentation() override

1479 { return "Directory Documentation"; }

trDirectories()

QCString TranslatorEnglish::trDirectories ()

inline virtual

This is used as the title of the directory index and also in the Quick links of an HTML page, to link to the directory hierarchy.

Definition at line 1484 of file translator_en.h.

1484 QCString trDirectories() override

1485 { return "Directories"; }

trDirIndex()

QCString TranslatorEnglish::trDirIndex ()

inline virtual

This is used as the name of the chapter containing the directory hierarchy.

Definition at line 1472 of file translator_en.h.

1472 QCString trDirIndex() override

1473 { return "Directory Hierarchy"; }

trDirReference()

QCString TranslatorEnglish::trDirReference (const QCString & dirName)

inline virtual

This returns the title of a directory page. The name of the directory is passed via dirName.

Definition at line 1490 of file translator_en.h.

1490 QCString trDirReference(const QCString &dirName) override

1491 { QCString result=dirName; result+=" Directory Reference"; return result; }

trDirRelation()

QCString TranslatorEnglish::trDirRelation (const QCString & name)

inline virtual

directory relation for name

Definition at line 1733 of file translator_en.h.

1733 QCString trDirRelation(const QCString &name) override

1734 {

1735 return name+" Relation";

1736 }

trDocumentation()

QCString TranslatorEnglish::trDocumentation (const QCString & projName)

inline virtual

This is used in HTML as the title of index.html.

Definition at line 368 of file translator_en.h.

368 QCString trDocumentation(const QCString &projName) override

369 { return (!projName.isEmpty()?projName + " " : "") + "Documentation"; }

Reference QCString::isEmpty.

trEnumerations()

QCString TranslatorEnglish::trEnumerations ()

inline virtual

This is used in the documentation of a file as a header before the list of enumerations

Definition at line 454 of file translator_en.h.

454 QCString trEnumerations() override

455 { return "Enumerations"; }

trEnumerationTypeDocumentation()

QCString TranslatorEnglish::trEnumerationTypeDocumentation ()

inline virtual

This is used in the documentation of a file/namespace before the list of documentation blocks for enumeration types

Definition at line 490 of file translator_en.h.

490 QCString trEnumerationTypeDocumentation() override

491 { return "Enumeration Type Documentation"; }

trEnumerationValueDocumentation()

QCString TranslatorEnglish::trEnumerationValueDocumentation ()

inline virtual

This is used in the documentation of a file/namespace before the list of documentation blocks for enumeration values

Definition at line 1528 of file translator_en.h.

1528 QCString trEnumerationValueDocumentation() override

1529 { return "Enumerator Documentation"; }

trEnumerationValues()

QCString TranslatorEnglish::trEnumerationValues ()

inline virtual

This is used in the documentation of a file as a header before the list of (global) variables

Definition at line 472 of file translator_en.h.

472 QCString trEnumerationValues() override

473 { return "Enumerator"; }

trEnumGeneratedFromFiles()

QCString TranslatorEnglish::trEnumGeneratedFromFiles (bool single)

inline virtual

Used file list for a Java enum

Definition at line 1865 of file translator_en.h.

1865 QCString trEnumGeneratedFromFiles(bool single) override

1866 { QCString result = "The documentation for this enum was generated from the following file";

1867 if (!single) result += "s";

1868 result+=":";

1869 return result;

1870 }

trEnumName()

QCString TranslatorEnglish::trEnumName ()

inline virtual

put after an enum name in the list of all members

Definition at line 169 of file translator_en.h.

169 QCString trEnumName() override

170 { return "enum name"; }

trEnumReference()

QCString TranslatorEnglish::trEnumReference (const QCString & name)

inline virtual

Header of a Java enum page (Java enums are represented as classes).

Definition at line 1873 of file translator_en.h.

1873 QCString trEnumReference(const QCString &name) override

1874 { return name+" Enum Reference"; }

trEnumValue()

QCString TranslatorEnglish::trEnumValue ()

inline virtual

put after an enum value in the list of all members

Definition at line 173 of file translator_en.h.

173 QCString trEnumValue() override

174 { return "enum value"; }

trEventDocumentation()

QCString TranslatorEnglish::trEventDocumentation ()

inline virtual

Header used for the documentation section of a class' events.

Definition at line 1346 of file translator_en.h.

1346 QCString trEventDocumentation() override

1347 {

1348 return "Event Documentation";

1349 }

trEvents()

QCString TranslatorEnglish::trEvents ()

inline virtual

Used as a header for declaration section of the events found in a C# program

Definition at line 1341 of file translator_en.h.

1341 QCString trEvents() override

1342 {

1343 return "Events";

1344 }

trExamples()

QCString TranslatorEnglish::trExamples ()

inline virtual

This is put above each page as a link to all examples.

Definition at line 240 of file translator_en.h.

240 QCString trExamples() override

241 { return "Examples"; }

trExamplesDescription()

QCString TranslatorEnglish::trExamplesDescription ()

inline virtual

This is an introduction to the page with the list of all examples

Definition at line 354 of file translator_en.h.

354 QCString trExamplesDescription() override

355 { return "Here is a list of all examples:"; }

trExceptionDocumentation()

QCString TranslatorEnglish::trExceptionDocumentation ()

inline virtual

Definition at line 2207 of file translator_en.h.

2207 QCString trExceptionDocumentation() override

2208 {

2209 return "Exception Documentation";

2210 }

trExceptionHierarchy()

QCString TranslatorEnglish::trExceptionHierarchy ()

inline virtual

Definition at line 2199 of file translator_en.h.

2199 QCString trExceptionHierarchy() override

2200 {

2201 return "Exception Hierarchy";

2202 }

trExceptionHierarchyDescription()

QCString TranslatorEnglish::trExceptionHierarchyDescription ()

inline virtual

Definition at line 2203 of file translator_en.h.

2203 QCString trExceptionHierarchyDescription() override

2204 {

2205 return "This inheritance list is sorted roughly, but not completely, alphabetically:";

2206 }

trExceptionIndex()

QCString TranslatorEnglish::trExceptionIndex ()

inline virtual

Definition at line 2187 of file translator_en.h.

2187 QCString trExceptionIndex() override

2188 {

2189 return "Exception Index";

2190 }

trExceptionList()

QCString TranslatorEnglish::trExceptionList ()

inline virtual

Definition at line 2191 of file translator_en.h.

2191 QCString trExceptionList() override

2192 {

2193 return "Exception List";

2194 }

trExceptionListDescription()

QCString TranslatorEnglish::trExceptionListDescription ()

inline virtual

Definition at line 2195 of file translator_en.h.

2195 QCString trExceptionListDescription() override

2196 {

2197 return "Here are the exceptions with brief descriptions:";

2198 }

trExceptions()

QCString TranslatorEnglish::trExceptions ()

inline virtual

this text is generated when the \exception command is used.

Definition at line 562 of file translator_en.h.

562 QCString trExceptions() override

563 { return "Exceptions"; }

trExportedModules()

QCString TranslatorEnglish::trExportedModules ()

inline virtual

Definition at line 2595 of file translator_en.h.

2595 QCString trExportedModules() override

2596 {

2597 return "Exported Modules";

2598 }

trExtendsClass()

QCString TranslatorEnglish::trExtendsClass ()

inline virtual

Used in a method of an Objective-C category that extends a class. Note that the @1 marker is required and is replaced by a link to the class method.

Definition at line 1913 of file translator_en.h.

1913 QCString trExtendsClass() override

1914 {

1915 return "Extends class @0.";

1916 }

trFile()

QCString TranslatorEnglish::trFile (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1218 of file translator_en.h.

1218 QCString trFile(bool first_capital, bool singular) override

1219 {

1220 return createNoun(first_capital, singular, "file", "s");

1221 }

Reference Translator::createNoun.

trFileDocumentation()

QCString TranslatorEnglish::trFileDocumentation ()

inline virtual

This is used in LaTeX as the title of the chapter containing the documentation of all files.

Definition at line 432 of file translator_en.h.

432 QCString trFileDocumentation() override

433 { return "File Documentation"; }

trFileIn()

QCString TranslatorEnglish::trFileIn (const QCString & name)

inline virtual

when clicking a directory dependency label, a page with a table is shown. The heading for the first column mentions the source file that has a relation to another file.

Definition at line 1770 of file translator_en.h.

1770 QCString trFileIn(const QCString &name) override

1771 {

1772 return "File in "+name;

1773 }

trFileIndex()

QCString TranslatorEnglish::trFileIndex ()

inline virtual

This is used in LaTeX as the title of the chapter with the list of all files.

Definition at line 401 of file translator_en.h.

401 QCString trFileIndex() override

402 { return "File Index"; }

trFileList()

QCString TranslatorEnglish::trFileList ()

inline virtual

This is put above each page as a link to the list of documented files

Definition at line 206 of file translator_en.h.

206 QCString trFileList() override

207 { return "File List"; }

trFileListDescription()

QCString TranslatorEnglish::trFileListDescription (bool extractAll)

inline virtual

This is an introduction to the list with all files.

Definition at line 262 of file translator_en.h.

262 QCString trFileListDescription(bool extractAll) override

263 {

264 QCString result="Here is a list of all ";

265 if (!extractAll) result+="documented ";

266 result+="files with brief descriptions:";

267 return result;

268 }

trFileMembers()

QCString TranslatorEnglish::trFileMembers ()

inline virtual

This is put above each page as a link to all members of files.

Definition at line 223 of file translator_en.h.

223 QCString trFileMembers() override

224 {

225 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

226 {

227 return "Globals";

228 }

229 else

230 {

231 return "File Members";

232 }

233 }

Reference Config_getBool.

trFileMembersDescription()

QCString TranslatorEnglish::trFileMembersDescription (bool extractAll)

inline virtual

This is an introduction to the page with all file members.

Definition at line 332 of file translator_en.h.

332 QCString trFileMembersDescription(bool extractAll) override

333 {

334 QCString result="Here is a list of all ";

335 if (!extractAll) result+="documented ";

336

337 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

338 {

339 result+="functions, variables, defines, enums, and typedefs";

340 }

341 else

342 {

343 result+="file members";

344 }

345 result+=" with links to ";

346 if (extractAll)

347 result+="the files they belong to:";

348 else

349 result+="the documentation:";

350 return result;

351 }

Reference Config_getBool.

trFileMembersDescriptionTotal()

QCString TranslatorEnglish::trFileMembersDescriptionTotal (FileMemberHighlight::Enum hl)

inline virtual

Definition at line 2368 of file translator_en.h.

2368 QCString trFileMembersDescriptionTotal(FileMemberHighlight::Enum hl) override

2369 {

2370 bool extractAll = Config_getBool(EXTRACT_ALL);

2371 QCString result="Here is a list of all ";

2372 if (!extractAll) result+="documented ";

2373

2374 switch (hl)

2375 {

2376 case FileMemberHighlight::All:

2377 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

2378 {

2379 result+="functions, variables, defines, enums, and typedefs";

2380 }

2381 else

2382 {

2383 result+="file members";

2384 }

2385 break;

2386 case FileMemberHighlight::Functions:

2387 result+="functions";

2388 break;

2389 case FileMemberHighlight::Variables:

2390 result+="variables";

2391 break;

2392 case FileMemberHighlight::Typedefs:

2393 result+="typedefs";

2394 break;

2395 case FileMemberHighlight::Sequences:

2396 result+="sequences";

2397 break;

2398 case FileMemberHighlight::Dictionaries:

2399 result+="dictionaries";

2400 break;

2401 case FileMemberHighlight::Enums:

2402 result+="enums";

2403 break;

2404 case FileMemberHighlight::EnumValues:

2405 result+="enum values";

2406 break;

2407 case FileMemberHighlight::Defines:

2408 result+="macros";

2409 break;

2410 case FileMemberHighlight::Total: // for completeness

2411 break;

2412 }

2413 result+=" with links to ";

2414 if (extractAll)

2415 result+="the files they belong to:";

2416 else

2417 result+="the documentation:";

2418 return result;

2419 }

References FileMemberHighlight::All, Config_getBool, FileMemberHighlight::Defines, FileMemberHighlight::Dictionaries, FileMemberHighlight::Enums, FileMemberHighlight::EnumValues, FileMemberHighlight::Functions, FileMemberHighlight::Sequences, FileMemberHighlight::Total, FileMemberHighlight::Typedefs and FileMemberHighlight::Variables.

trFileReference()

QCString TranslatorEnglish::trFileReference (const QCString & fileName)

inline virtual

used as the title of the HTML page of a file

Definition at line 629 of file translator_en.h.

629 QCString trFileReference(const QCString &fileName) override

630 {

631 QCString result=fileName;

632 result+=" File Reference";

633 return result;

634 }

trFlowchart()

QCString TranslatorEnglish::trFlowchart ()

inline virtual

This is used for translation of the word that will be followed by a single name of the VHDL process flowchart.

Definition at line 2312 of file translator_en.h.

2312 QCString trFlowchart() override

2313 { return "Flowchart:"; }

trFriends()

QCString TranslatorEnglish::trFriends ()

inline virtual

used in the class documentation as a header before the list of all friends of a class

Definition at line 589 of file translator_en.h.

589 QCString trFriends() override

590 { return "Friends"; }

trFunctionAndProc()

QCString TranslatorEnglish::trFunctionAndProc ()

inline virtual

VHDL functions/procedures/processes.

Definition at line 2023 of file translator_en.h.

2023 QCString trFunctionAndProc() override

2024 { return "Functions/Procedures/Processes"; }

trFunctionDocumentation()

QCString TranslatorEnglish::trFunctionDocumentation ()

inline virtual

This is used in the documentation of a file/namespace before the list of documentation blocks for functions

Definition at line 496 of file translator_en.h.

496 QCString trFunctionDocumentation() override

497 { return "Function Documentation"; }

trFunctions()

QCString TranslatorEnglish::trFunctions ()

inline virtual

This is used in the documentation of a file as a header before the list of (global) functions

Definition at line 460 of file translator_en.h.

460 QCString trFunctions() override

461 { return "Functions"; }

trGeneratedAt()

QCString TranslatorEnglish::trGeneratedAt (const QCString & date, const QCString & projName)

inline virtual

This is used in the standard footer of each page and indicates when the page was generated

Definition at line 523 of file translator_en.h.

523 QCString trGeneratedAt(const QCString &date,const QCString &projName) override

524 {

525 QCString result="Generated on "+date;

526 if (!projName.isEmpty()) result+=" for "+projName;

527 result+=" by";

528 return result;

529 }

Reference QCString::isEmpty.

trGeneratedAutomatically()

QCString TranslatorEnglish::trGeneratedAutomatically (const QCString & s)

inline virtual

this is put at the author sections at the bottom of man pages. parameter s is name of the project name.

Definition at line 161 of file translator_en.h.

161 QCString trGeneratedAutomatically(const QCString &s) override

162 { QCString result="Generated automatically by Doxygen";

163 if (!s.isEmpty()) result+=" for "+s;

164 result+=" from the source code.";

165 return result;

166 }

Reference QCString::isEmpty.

trGeneratedBy()

QCString TranslatorEnglish::trGeneratedBy ()

inline virtual

this text is used in the title page of a LaTeX document.

Definition at line 566 of file translator_en.h.

566 QCString trGeneratedBy() override

567 { return "Generated by"; }

trGeneratedFromFiles()

QCString TranslatorEnglish::trGeneratedFromFiles (ClassDef::CompoundType compType, bool single)

inline virtual

This is put at the bottom of a class documentation page and is followed by a list of files that were used to generate the page.

Definition at line 766 of file translator_en.h.

766 QCString trGeneratedFromFiles(ClassDef::CompoundType compType,

767 bool single) override

768 { // single is true implies a single file

769 bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);

770 QCString result="The documentation for this ";

771 switch(compType)

772 {

773 case ClassDef::Class: result+=vhdlOpt?"design unit":"class"; break;

774 case ClassDef::Struct: result+="struct"; break;

775 case ClassDef::Union: result+="union"; break;

776 case ClassDef::Interface: result+="interface"; break;

777 case ClassDef::Protocol: result+="protocol"; break;

778 case ClassDef::Category: result+="category"; break;

779 case ClassDef::Exception: result+="exception"; break;

780 default: break;

781 }

782 result+=" was generated from the following file";

783 if (single) result+=":"; else result+="s:";

784 return result;

785 }

References ClassDef::Category, ClassDef::Class, Config_getBool, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct and ClassDef::Union.

trGeneratedFromFilesFortran()

QCString TranslatorEnglish::trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single)

inline virtual

This is put at the bottom of a module documentation page and is followed by a list of files that were used to generate the page.

Definition at line 1683 of file translator_en.h.

1683 QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType,

1684 bool single) override

1685 {

1686 // single is true implies a single file

1687 QCString result="The documentation for this ";

1688 switch(compType)

1689 {

1690 case ClassDef::Class: result+="module"; break;

1691 case ClassDef::Struct: result+="type"; break;

1692 case ClassDef::Union: result+="union"; break;

1693 case ClassDef::Interface: result+="interface"; break;

1694 case ClassDef::Protocol: result+="protocol"; break;

1695 case ClassDef::Category: result+="category"; break;

1696 case ClassDef::Exception: result+="exception"; break;

1697 default: break;

1698 }

1699 result+=" was generated from the following file";

1700 if (single) result+=":"; else result+="s:";

1701 return result;

1702 }

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, ClassDef::Struct and ClassDef::Union.

trGlobal()

QCString TranslatorEnglish::trGlobal (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1263 of file translator_en.h.

1263 QCString trGlobal(bool first_capital, bool singular) override

1264 {

1265 return createNoun(first_capital, singular, "global", "s");

1266 }

Reference Translator::createNoun.

trGlobalNamespace()

QCString TranslatorEnglish::trGlobalNamespace ()

inline virtual

Label used for search results in the global namespace

Definition at line 1745 of file translator_en.h.

1745 QCString trGlobalNamespace() override

1746 {

1747 return "Global Namespace";

1748 }

trGotoDocumentation()

QCString TranslatorEnglish::trGotoDocumentation ()

inline virtual

Used in the file sources to point to the corresponding documentation.

Definition at line 853 of file translator_en.h.

853 QCString trGotoDocumentation() override

854 {

855 return "Go to the documentation of this file.";

856 }

trGotoGraphicalHierarchy()

QCString TranslatorEnglish::trGotoGraphicalHierarchy ()

inline virtual

Definition at line 886 of file translator_en.h.

886 QCString trGotoGraphicalHierarchy() override

887 {

888 return "Go to the graphical class hierarchy";

889 }

trGotoSourceCode()

QCString TranslatorEnglish::trGotoSourceCode ()

inline virtual

Used in the file documentation to point to the corresponding sources.

Definition at line 848 of file translator_en.h.

848 QCString trGotoSourceCode() override

849 {

850 return "Go to the source code of this file.";

851 }

trGotoTextualHierarchy()

QCString TranslatorEnglish::trGotoTextualHierarchy ()

inline virtual

Definition at line 890 of file translator_en.h.

890 QCString trGotoTextualHierarchy() override

891 {

892 return "Go to the textual class hierarchy";

893 }

trGraphicalHierarchy()

QCString TranslatorEnglish::trGraphicalHierarchy ()

inline virtual

Definition at line 882 of file translator_en.h.

882 QCString trGraphicalHierarchy() override

883 {

884 return "Graphical Class Hierarchy";

885 }

trGroup()

QCString TranslatorEnglish::trGroup (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1236 of file translator_en.h.

1236 QCString trGroup(bool first_capital, bool singular) override

1237 {

1238 return createNoun(first_capital, singular, "module", "s");

1239 }

Reference Translator::createNoun.

trHierarchicalIndex()

QCString TranslatorEnglish::trHierarchicalIndex ()

inline virtual

This is used in LaTeX as the title of the chapter with the class hierarchy.

Definition at line 380 of file translator_en.h.

380 QCString trHierarchicalIndex() override

381 { return "Hierarchical Index"; }

trImplementedFromList()

QCString TranslatorEnglish::trImplementedFromList (int numEntries)

inline virtual

used in member documentation blocks to produce a list of members that are implemented by this one.

Definition at line 1297 of file translator_en.h.

1297 QCString trImplementedFromList(int numEntries) override

1298 {

1299 return "Implements "+trWriteList(numEntries)+".";

1300 }

Reference trWriteList.

trImplementedInList()

QCString TranslatorEnglish::trImplementedInList (int numEntries)

inline virtual

used in member documentation blocks to produce a list of all members that implement this abstract member.

Definition at line 1305 of file translator_en.h.

1305 QCString trImplementedInList(int numEntries) override

1306 {

1307 return "Implemented in "+trWriteList(numEntries)+".";

1308 }

Reference trWriteList.

trImportant()

QCString TranslatorEnglish::trImportant ()

inline virtual

Definition at line 2611 of file translator_en.h.

2611 QCString trImportant() override

2612 {

2613 return "Important";

2614 }

trInclByDepGraph()

QCString TranslatorEnglish::trInclByDepGraph ()

inline virtual

Definition at line 982 of file translator_en.h.

982 QCString trInclByDepGraph() override

983 {

984 return "This graph shows which files directly or "

985 "indirectly include this file:";

986 }

trInclDepGraph()

QCString TranslatorEnglish::trInclDepGraph (const QCString & fName)

inline virtual

this text is put before an include dependency graph

Definition at line 838 of file translator_en.h.

838 QCString trInclDepGraph(const QCString &fName) override

839 {

840 return "Include dependency graph for "+fName+":";

841 }

trIncludesFileIn()

QCString TranslatorEnglish::trIncludesFileIn (const QCString & name)

inline virtual

when clicking a directory dependency label, a page with a table is shown. The heading for the second column mentions the destination file that is included.

Definition at line 1779 of file translator_en.h.

1779 QCString trIncludesFileIn(const QCString &name) override

1780 {

1781 return "Includes file in "+name;

1782 }

trIncludingInheritedMembers()

QCString TranslatorEnglish::trIncludingInheritedMembers ()

inline virtual

this is the remainder of the sentence after the class name

Definition at line 155 of file translator_en.h.

155 QCString trIncludingInheritedMembers() override

156 { return ", including all inherited members."; }

trInheritedByList()

QCString TranslatorEnglish::trInheritedByList (int numEntries)

inline virtual

used in class documentation to produce a list of super classes, if class diagrams are disabled.

Definition at line 700 of file translator_en.h.

700 QCString trInheritedByList(int numEntries) override

701 {

702 return "Inherited by "+trWriteList(numEntries)+".";

703 }

Reference trWriteList.

trInheritedFrom()

QCString TranslatorEnglish::trInheritedFrom (const QCString & members, const QCString & what)

inline virtual

Used for a section containing inherited members

Definition at line 1877 of file translator_en.h.

1877 QCString trInheritedFrom(const QCString &members,const QCString &what) override

1878 { return members+" inherited from "+what; }

trInheritsList()

QCString TranslatorEnglish::trInheritsList (int numEntries)

inline virtual

used in class documentation to produce a list of base classes, if class diagrams are disabled.

Definition at line 692 of file translator_en.h.

692 QCString trInheritsList(int numEntries) override

693 {

694 return "Inherits "+trWriteList(numEntries)+".";

695 }

Reference trWriteList.

trInitialValue()

QCString TranslatorEnglish::trInitialValue ()

inline virtual

Text shown before a multi-line variable/enum initialization

Definition at line 873 of file translator_en.h.

873 QCString trInitialValue() override

874 {

875 return "Initial value:";

876 }

trInstanceMethods()

QCString TranslatorEnglish::trInstanceMethods ()

inline virtual

Used as the header of a list of instance methods in Objective-C. These are similar to public member functions in C++.

Definition at line 1929 of file translator_en.h.

1929 QCString trInstanceMethods() override

1930 {

1931 return "Instance Methods";

1932 }

trInterfaceDocumentation()

QCString TranslatorEnglish::trInterfaceDocumentation ()

inline virtual

Definition at line 2163 of file translator_en.h.

2163 QCString trInterfaceDocumentation() override

2164 {

2165 return "Interface Documentation";

2166 }

trInterfaceHierarchy()

QCString TranslatorEnglish::trInterfaceHierarchy ()

inline virtual

Definition at line 2155 of file translator_en.h.

2155 QCString trInterfaceHierarchy() override

2156 {

2157 return "Interface Hierarchy";

2158 }

trInterfaceHierarchyDescription()

QCString TranslatorEnglish::trInterfaceHierarchyDescription ()

inline virtual

Definition at line 2159 of file translator_en.h.

2159 QCString trInterfaceHierarchyDescription() override

2160 {

2161 return "This inheritance list is sorted roughly, but not completely, alphabetically:";

2162 }

trInterfaceIndex()

QCString TranslatorEnglish::trInterfaceIndex ()

inline virtual

Definition at line 2143 of file translator_en.h.

2143 QCString trInterfaceIndex() override

2144 {

2145 return "Interface Index";

2146 }

trInterfaceList()

QCString TranslatorEnglish::trInterfaceList ()

inline virtual

Definition at line 2147 of file translator_en.h.

2147 QCString trInterfaceList() override

2148 {

2149 return "Interface List";

2150 }

trInterfaceListDescription()

QCString TranslatorEnglish::trInterfaceListDescription ()

inline virtual

Definition at line 2151 of file translator_en.h.

2151 QCString trInterfaceListDescription() override

2152 {

2153 return "Here are the interfaces with brief descriptions:";

2154 }

trInterfaces()

QCString TranslatorEnglish::trInterfaces ()

inline virtual

old style UNO IDL services: implemented interfaces

Definition at line 1946 of file translator_en.h.

1946 QCString trInterfaces() override

1947 { return "Exported Interfaces"; }

trInvariant()

QCString TranslatorEnglish::trInvariant ()

inline virtual

Text for the \invariant command

Definition at line 868 of file translator_en.h.

868 QCString trInvariant() override

869 {

870 return "Invariant";

871 }

trISOLang()

QCString TranslatorEnglish::trISOLang ()

inline virtual

Definition at line 77 of file translator_en.h.

77 QCString trISOLang() override

78 {

79 return "en-US";

80 }

trLegend()

QCString TranslatorEnglish::trLegend ()

inline virtual

text for the link to the legend page

Definition at line 1069 of file translator_en.h.

1069 QCString trLegend() override

1070 {

1071 return "legend";

1072 }

trLegendDocs()

QCString TranslatorEnglish::trLegendDocs ()

inline virtual

page explaining how the dot graph's should be interpreted The A in the text below are to prevent link to classes called "A".

Definition at line 1004 of file translator_en.h.

1004 QCString trLegendDocs() override

1005 {

1006 return

1007 "This page explains how to interpret the graphs that are generated "

1008 "by doxygen.\n"

1009 "Consider the following example:\n"

1010 "\\code\n"

1011 "/*! Invisible class because of truncation */\n"

1012 "class Invisible { };\n\n"

1013 "/*! Truncated class, inheritance relation is hidden */\n"

1014 "class Truncated : public Invisible { };\n\n"

1015 "/* Class not documented with doxygen comments */\n"

1016 "class Undocumented { };\n\n"

1017 "/*! Class that is inherited using public inheritance */\n"

1018 "class PublicBase : public Truncated { };\n\n"

1019 "/*! A template class */\n"

1020 "template<class T> class Templ { };\n\n"

1021 "/*! Class that is inherited using protected inheritance */\n"

1022 "class ProtectedBase { };\n\n"

1023 "/*! Class that is inherited using private inheritance */\n"

1024 "class PrivateBase { };\n\n"

1025 "/*! Class that is used by the Inherited class */\n"

1026 "class Used { };\n\n"

1027 "/*! Super class that inherits a number of other classes */\n"

1028 "class Inherited : public PublicBase,\n"

1029 " protected ProtectedBase,\n"

1030 " private PrivateBase,\n"

1031 " public Undocumented,\n"

1032 " public Templ<int>\n"

1033 "{\n"

1034 " private:\n"

1035 " Used *m_usedClass;\n"

1036 "};\n"

1037 "\\endcode\n"

1038 "This will result in the following graph:"

1039 "<center><img alt=\"\" src=\"graph_legend."+getDotImageExtension()+"\"></center>\n"

1040 "\n"

1041 "The boxes in the above graph have the following meaning:\n"

1042 "\n"

1043 "<ul>\n"

1044 "<li>%A filled gray box represents the struct or class for which the "

1045 "graph is generated.</li>\n"

1046 "<li>%A box with a black border denotes a documented struct or class.</li>\n"

1047 "<li>%A box with a gray border denotes an undocumented struct or class.</li>\n"

1048 "<li>%A box with a red border denotes a documented struct or class for"

1049 "which not all inheritance/containment relations are shown. %A graph is "

1050 "truncated if it does not fit within the specified boundaries.</li>\n"

1051 "</ul>\n"

1052 "\n"

1053 "The arrows have the following meaning:\n"

1054 "\n"

1055 "<ul>\n"

1056 "<li>%A blue arrow is used to visualize a public inheritance "

1057 "relation between two classes.</li>\n"

1058 "<li>%A dark green arrow is used for protected inheritance.</li>\n"

1059 "<li>%A dark red arrow is used for private inheritance.</li>\n"

1060 "<li>%A purple dashed arrow is used if a class is contained or used "

1061 "by another class. The arrow is labeled with the variable(s) "

1062 "through which the pointed class or struct is accessible.</li>\n"

1063 "<li>%A yellow dashed arrow denotes a relation between a template instance and "

1064 "the template class it was instantiated from. The arrow is labeled with "

1065 "the template parameters of the instance.</li>\n"

1066 "</ul>\n";

1067 }

Reference getDotImageExtension.

trLegendTitle()

QCString TranslatorEnglish::trLegendTitle ()

inline virtual

title of the graph legend page

Definition at line 997 of file translator_en.h.

997 QCString trLegendTitle() override

998 {

999 return "Graph Legend";

1000 }

trListOfAllMembers()

QCString TranslatorEnglish::trListOfAllMembers ()

inline virtual

put in the class documentation

Definition at line 143 of file translator_en.h.

143 QCString trListOfAllMembers() override

144 { return "List of all members"; }

trLoading()

QCString TranslatorEnglish::trLoading ()

inline virtual

Loading message shown when loading search results

Definition at line 1739 of file translator_en.h.

1739 QCString trLoading() override

1740 {

1741 return "Loading...";

1742 }

trMainPage()

QCString TranslatorEnglish::trMainPage ()

inline virtual

This is in the (quick) index as a link to the main page (index.html)

Definition at line 797 of file translator_en.h.

797 QCString trMainPage() override

798 { return "Main Page"; }

trMember()

QCString TranslatorEnglish::trMember (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1254 of file translator_en.h.

1254 QCString trMember(bool first_capital, bool singular) override

1255 {

1256 return createNoun(first_capital, singular, "member", "s");

1257 }

Reference Translator::createNoun.

trMemberDataDocumentation()

QCString TranslatorEnglish::trMemberDataDocumentation ()

inline virtual

header that is put before the list of member attributes.

Definition at line 126 of file translator_en.h.

126 QCString trMemberDataDocumentation() override

127 {

128 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

129 {

130 return "Field Documentation";

131 }

132 else

133 {

134 return "Member Data Documentation";

135 }

136 }

Reference Config_getBool.

trMemberEnumerationDocumentation()

QCString TranslatorEnglish::trMemberEnumerationDocumentation ()

inline virtual

header that is put before the list of enumerations.

Definition at line 109 of file translator_en.h.

109 QCString trMemberEnumerationDocumentation() override

110 { return "Member Enumeration Documentation"; }

trMemberFunctionDocumentation()

QCString TranslatorEnglish::trMemberFunctionDocumentation ()

inline virtual

header that is put before the list of member functions.

Definition at line 113 of file translator_en.h.

113 QCString trMemberFunctionDocumentation() override

114 {

115 if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))

116 {

117 return "Member Function/Procedure/Process Documentation";

118 }

119 else

120 {

121 return "Member Function Documentation";

122 }

123 }

Reference Config_getBool.

trMemberFunctionDocumentationFortran()

QCString TranslatorEnglish::trMemberFunctionDocumentationFortran ()

inline virtual

header that is put before the list of member subprograms (Fortran).

Definition at line 1536 of file translator_en.h.

1536 QCString trMemberFunctionDocumentationFortran() override

1537 { return "Member Function/Subroutine Documentation"; }

trMemberList()

QCString TranslatorEnglish::trMemberList ()

inline virtual

used as the title of the "list of all members" page of a class

Definition at line 147 of file translator_en.h.

147 QCString trMemberList() override

148 { return "Member List"; }

trMemberTypedefDocumentation()

QCString TranslatorEnglish::trMemberTypedefDocumentation ()

inline virtual

header that is put before the list of typedefs.

Definition at line 105 of file translator_en.h.

105 QCString trMemberTypedefDocumentation() override

106 { return "Member Typedef Documentation"; }

trMethodDocumentation()

QCString TranslatorEnglish::trMethodDocumentation ()

inline virtual

Used as the header of the member functions of an Objective-C class.

Definition at line 1936 of file translator_en.h.

1936 QCString trMethodDocumentation() override

1937 {

1938 return "Method Documentation";

1939 }

trModule()

QCString TranslatorEnglish::trModule (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1675 of file translator_en.h.

1675 QCString trModule(bool first_capital, bool singular) override

1676 {

1677 return createNoun(first_capital, singular, "module", "s");

1678 }

Reference Translator::createNoun.

trModuleDocumentation()

QCString TranslatorEnglish::trModuleDocumentation ()

inline virtual

This is used in LaTeX as the title of the chapter containing the documentation of all groups.

Definition at line 407 of file translator_en.h.

407 QCString trModuleDocumentation() override

408 { return "Module Documentation"; }

trModuleIndex()

QCString TranslatorEnglish::trModuleIndex ()

inline virtual

This is used in LaTeX as the title of the chapter with the index of all groups.

Definition at line 374 of file translator_en.h.

374 QCString trModuleIndex() override

375 { return "Module Index"; }

trModuleMembersDescriptionTotal()

QCString TranslatorEnglish::trModuleMembersDescriptionTotal (ModuleMemberHighlight::Enum hl)

inline virtual

Definition at line 2556 of file translator_en.h.

2556 QCString trModuleMembersDescriptionTotal(ModuleMemberHighlight::Enum hl) override

2557 {

2558 bool extractAll = Config_getBool(EXTRACT_ALL);

2559 QCString result="Here is a list of all ";

2560 if (!extractAll) result+="documented ";

2561 result+="module ";

2562 QCString singularResult = "";

2563 QCString pluralResult = "";

2564 switch (hl)

2565 {

2566 case ModuleMemberHighlight::All:

2567 singularResult="member";

2568 break;

2569 case ModuleMemberHighlight::Functions:

2570 singularResult="function";

2571 break;

2572 case ModuleMemberHighlight::Variables:

2573 singularResult="variable";

2574 break;

2575 case ModuleMemberHighlight::Typedefs:

2576 singularResult="typedef";

2577 break;

2578 case ModuleMemberHighlight::Enums:

2579 singularResult="enum";

2580 break;

2581 case ModuleMemberHighlight::EnumValues:

2582 singularResult="enum value";

2583 break;

2584 case ModuleMemberHighlight::Total: // for completeness

2585 break;

2586 }

2587 result+=(pluralResult.isEmpty() ? singularResult+"s" : pluralResult);

2588 result+=" with links to ";

2589 if (extractAll)

2590 result+="the module documentation for each " + singularResult + ":";

2591 else

2592 result+="the module they belong to:";

2593 return result;

2594 }

References ModuleMemberHighlight::All, Config_getBool, ModuleMemberHighlight::Enums, ModuleMemberHighlight::EnumValues, ModuleMemberHighlight::Functions, QCString::isEmpty, ModuleMemberHighlight::Total, ModuleMemberHighlight::Typedefs and ModuleMemberHighlight::Variables.

trModuleReference()

QCString TranslatorEnglish::trModuleReference (const QCString & namespaceName)

inline virtual

used as the title of the HTML page of a module (Fortran)

Definition at line 1637 of file translator_en.h.

1637 QCString trModuleReference(const QCString &namespaceName) override

1638 {

1639 QCString result=namespaceName;

1640 result+=" Module Reference";

1641 return result;

1642 }

trModules()

QCString TranslatorEnglish::trModules ()

inline virtual

This is put above each page as a link to the list of all groups of compounds or files (see the \group command).

Definition at line 185 of file translator_en.h.

185 QCString trModules() override

186 { return "Modules"; }

trModulesDescription()

QCString TranslatorEnglish::trModulesDescription ()

inline virtual

This is an introduction to the page with the list of class/file groups

Definition at line 362 of file translator_en.h.

362 QCString trModulesDescription() override

363 { return "Here is a list of all modules:"; }

trModulesIndex()

QCString TranslatorEnglish::trModulesIndex ()

inline virtual

This is used in LaTeX as the title of the chapter with the index of all modules (Fortran).

Definition at line 1668 of file translator_en.h.

1668 QCString trModulesIndex() override

1669 { return "Modules Index"; }

trModulesList()

QCString TranslatorEnglish::trModulesList ()

inline virtual

used as the title of page containing all the index of all modules (Fortran).

Definition at line 1603 of file translator_en.h.

1603 QCString trModulesList() override

1604 { return "Modules List"; }

trModulesListDescription()

QCString TranslatorEnglish::trModulesListDescription (bool extractAll)

inline virtual

used as an introduction to the modules list (Fortran)

Definition at line 1607 of file translator_en.h.

1607 QCString trModulesListDescription(bool extractAll) override

1608 {

1609 QCString result="Here is a list of all ";

1610 if (!extractAll) result+="documented ";

1611 result+="modules with brief descriptions:";

1612 return result;

1613 }

trModulesMemberDescription()

QCString TranslatorEnglish::trModulesMemberDescription (bool extractAll)

inline virtual

This is an introduction to the page with all modules members (Fortran)

Definition at line 1649 of file translator_en.h.

1649 QCString trModulesMemberDescription(bool extractAll) override

1650 {

1651 QCString result="Here is a list of all ";

1652 if (!extractAll) result+="documented ";

1653 result+="module members with links to ";

1654 if (extractAll)

1655 {

1656 result+="the module documentation for each member:";

1657 }

1658 else

1659 {

1660 result+="the modules they belong to:";

1661 }

1662 return result;

1663 }

trModulesMembers()

QCString TranslatorEnglish::trModulesMembers ()

inline virtual

This is put above each page as a link to all members of modules. (Fortran)

Definition at line 1645 of file translator_en.h.

1645 QCString trModulesMembers() override

1646 { return "Module Members"; }

trMonth()

QCString TranslatorEnglish::trMonth (int month, bool, bool full)

inline virtual

Definition at line 1820 of file translator_en.h.

1820 QCString trMonth(int month, bool, bool full) override

1821 {

1822 static const char *months_short[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };

1823 static const char *months_full[] = { "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" };

1824 return full? months_full[month-1] : months_short[month-1];

1825 }

trMore()

QCString TranslatorEnglish::trMore ()

inline virtual

this is the text of a link put after brief descriptions.

Definition at line 139 of file translator_en.h.

139 QCString trMore() override

140 { return "More..."; }

trNamespace()

QCString TranslatorEnglish::trNamespace (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1227 of file translator_en.h.

1227 QCString trNamespace(bool first_capital, bool singular) override

1228 {

1229 return createNoun(first_capital, singular, "namespace", "s");

1230 }

Reference Translator::createNoun.

trNamespaceDocumentation()

QCString TranslatorEnglish::trNamespaceDocumentation ()

inline virtual

This is used in LaTeX as the title of the chapter containing the documentation of all namespaces.

Definition at line 746 of file translator_en.h.

746 QCString trNamespaceDocumentation() override

747 { return "Namespace Documentation"; }

trNamespaceIndex()

QCString TranslatorEnglish::trNamespaceIndex ()

inline virtual

This is used in LaTeX as the title of the chapter with the index of all namespaces.

Definition at line 740 of file translator_en.h.

740 QCString trNamespaceIndex() override

741 { return "Namespace Index"; }

trNamespaceList()

QCString TranslatorEnglish::trNamespaceList ()

inline virtual

used as the title of page containing all the index of all namespaces.

Definition at line 574 of file translator_en.h.

574 QCString trNamespaceList() override

575 { return "Namespace List"; }

trNamespaceListDescription()

QCString TranslatorEnglish::trNamespaceListDescription (bool extractAll)

inline virtual

used as an introduction to the namespace list

Definition at line 578 of file translator_en.h.

578 QCString trNamespaceListDescription(bool extractAll) override

579 {

580 QCString result="Here is a list of all ";

581 if (!extractAll) result+="documented ";

582 result+="namespaces with brief descriptions:";

583 return result;

584 }

trNamespaceMemberDescription()

QCString TranslatorEnglish::trNamespaceMemberDescription (bool extractAll)

inline virtual

This is an introduction to the page with all namespace members

Definition at line 726 of file translator_en.h.

726 QCString trNamespaceMemberDescription(bool extractAll) override

727 {

728 QCString result="Here is a list of all ";

729 if (!extractAll) result+="documented ";

730 result+="namespace members with links to ";

731 if (extractAll)

732 result+="the namespace documentation for each member:";

733 else

734 result+="the namespaces they belong to:";

735 return result;

736 }

trNamespaceMembers()

QCString TranslatorEnglish::trNamespaceMembers ()

inline virtual

This is put above each page as a link to all members of namespaces.

Definition at line 722 of file translator_en.h.

722 QCString trNamespaceMembers() override

723 { return "Namespace Members"; }

trNamespaceMembersDescriptionTotal()

QCString TranslatorEnglish::trNamespaceMembersDescriptionTotal (NamespaceMemberHighlight::Enum hl)

inline virtual

Definition at line 2493 of file translator_en.h.

2493 QCString trNamespaceMembersDescriptionTotal(NamespaceMemberHighlight::Enum hl) override

2494 {

2495 bool extractAll = Config_getBool(EXTRACT_ALL);

2496 QCString result="Here is a list of all ";

2497 if (!extractAll) result+="documented ";

2498 result+="namespace ";

2499 QCString singularResult = "";

2500 QCString pluralResult = "";

2501 switch (hl)

2502 {

2503 case NamespaceMemberHighlight::All:

2504 singularResult="member";

2505 break;

2506 case NamespaceMemberHighlight::Functions:

2507 singularResult="function";

2508 break;

2509 case NamespaceMemberHighlight::Variables:

2510 singularResult="variable";

2511 break;

2512 case NamespaceMemberHighlight::Typedefs:

2513 singularResult="typedef";

2514 break;

2515 case NamespaceMemberHighlight::Sequences:

2516 singularResult="sequence";

2517 break;

2518 case NamespaceMemberHighlight::Dictionaries:

2519 singularResult="dictionary";

2520 pluralResult="dictionaries";

2521 break;

2522 case NamespaceMemberHighlight::Enums:

2523 singularResult="enum";

2524 break;

2525 case NamespaceMemberHighlight::EnumValues:

2526 singularResult="enum value";

2527 break;

2528 case NamespaceMemberHighlight::Total: // for completeness

2529 break;

2530 }

2531 result+=(pluralResult.isEmpty() ? singularResult+"s" : pluralResult);

2532 result+=" with links to ";

2533 if (extractAll)

2534 result+="the namespace documentation for each " + singularResult + ":";

2535 else

2536 result+="the namespaces they belong to:";

2537 return result;

2538 }

References NamespaceMemberHighlight::All, Config_getBool, NamespaceMemberHighlight::Dictionaries, NamespaceMemberHighlight::Enums, NamespaceMemberHighlight::EnumValues, NamespaceMemberHighlight::Functions, QCString::isEmpty, NamespaceMemberHighlight::Sequences, NamespaceMemberHighlight::Total, NamespaceMemberHighlight::Typedefs and NamespaceMemberHighlight::Variables.

trNamespaceReference()

QCString TranslatorEnglish::trNamespaceReference (const QCString & namespaceName)

inline virtual

used as the title of the HTML page of a namespace

Definition at line 637 of file translator_en.h.

637 QCString trNamespaceReference(const QCString &namespaceName) override

638 {

639 QCString result=namespaceName;

640 result+=" Namespace Reference";

641 return result;

642 }

trNamespaces()

QCString TranslatorEnglish::trNamespaces ()

inline virtual

This is used in the documentation before the list of all namespaces in a file.

Definition at line 756 of file translator_en.h.

756 QCString trNamespaces() override

757 { return "Namespaces"; }

trNoMatches()

QCString TranslatorEnglish::trNoMatches ()

inline virtual

Text shown when no search results are found

Definition at line 1757 of file translator_en.h.

1757 QCString trNoMatches() override

1758 {

1759 return "No Matches";

1760 }

trNote()

QCString TranslatorEnglish::trNote ()

inline virtual

Definition at line 903 of file translator_en.h.

903 QCString trNote() override

904 {

905 return "Note";

906 }

trOperationDocumentation()

QCString TranslatorEnglish::trOperationDocumentation ()

inline virtual

Definition at line 2233 of file translator_en.h.

2233 QCString trOperationDocumentation() override

2234 {

2235 return "Operation Documentation";

2236 }

trOperations()

QCString TranslatorEnglish::trOperations ()

inline virtual

Definition at line 2229 of file translator_en.h.

2229 QCString trOperations() override

2230 {

2231 return "Operations";

2232 }

trOverloadText()

QCString TranslatorEnglish::trOverloadText ()

inline virtual

This text is added to the documentation when the \overload command is used for a overloaded function.

Definition at line 1508 of file translator_en.h.

1508 QCString trOverloadText() override

1509 {

1510 return "This is an overloaded member function, "

1511 "provided for convenience. It differs from the above "

1512 "function only in what argument(s) it accepts.";

1513 }

trPackage()

QCString TranslatorEnglish::trPackage (const QCString & name)

inline virtual

Used as the title of a Java package

Definition at line 1121 of file translator_en.h.

1121 QCString trPackage(const QCString &name) override

1122 {

1123 return "Package "+name;

1124 }

trPackageAttribs()

QCString TranslatorEnglish::trPackageAttribs ()

inline virtual

Used as a heading for a list of Java class variables with package scope.

Definition at line 1382 of file translator_en.h.

1382 QCString trPackageAttribs() override

1383 {

1384 return "Package Attributes";

1385 }

trPackageFunctions()

QCString TranslatorEnglish::trPackageFunctions ()

inline virtual

Used as a heading for a list of Java class functions with package scope.

Definition at line 1364 of file translator_en.h.

1364 QCString trPackageFunctions() override

1365 {

1366 return "Package Functions";

1367 }

trPackageList()

QCString TranslatorEnglish::trPackageList ()

inline virtual

Definition at line 2302 of file translator_en.h.

2302 QCString trPackageList() override

2303 { return "Package List"; }

trPackageListDescription()

QCString TranslatorEnglish::trPackageListDescription ()

inline virtual

The description of the package index page

Definition at line 1126 of file translator_en.h.

1126 QCString trPackageListDescription() override

1127 {

1128 return "Here are the packages with brief descriptions (if available):";

1129 }

trPackageMembers()

QCString TranslatorEnglish::trPackageMembers ()

inline virtual

Definition at line 1368 of file translator_en.h.

1368 QCString trPackageMembers() override

1369 {

1370 return "Package Members";

1371 }

trPackages()

QCString TranslatorEnglish::trPackages ()

inline virtual

The link name in the Quick links header for each page

Definition at line 1131 of file translator_en.h.

1131 QCString trPackages() override

1132 {

1133 return "Packages";

1134 }

trPackageTypes()

QCString TranslatorEnglish::trPackageTypes ()

inline virtual

Used as a heading for a list of Java class types with package scope.

Definition at line 1357 of file translator_en.h.

1357 QCString trPackageTypes() override

1358 {

1359 return "Package Types";

1360 }

trPage()

QCString TranslatorEnglish::trPage (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1245 of file translator_en.h.

1245 QCString trPage(bool first_capital, bool singular) override

1246 {

1247 return createNoun(first_capital, singular, "page", "s");

1248 }

Reference Translator::createNoun.

trPageAbbreviation()

QCString TranslatorEnglish::trPageAbbreviation ()

inline virtual

This is used in references to page that are put in the LaTeX documentation. It should be an abbreviation of the word page.

Definition at line 803 of file translator_en.h.

803 QCString trPageAbbreviation() override

804 { return "p."; }

trPageIndex()

QCString TranslatorEnglish::trPageIndex ()

inline virtual

Definition at line 894 of file translator_en.h.

894 QCString trPageIndex() override

895 {

896 return "Page Index";

897 }

trPanelSynchronisationTooltip()

QCString TranslatorEnglish::trPanelSynchronisationTooltip (bool enable)

inline virtual

Used as a tooltip for the toggle button that appears in the navigation tree in the HTML output when GENERATE_TREEVIEW is enabled. This tooltip explains the meaning of the button.

Definition at line 1894 of file translator_en.h.

1894 QCString trPanelSynchronisationTooltip(bool enable) override

1895 {

1896 QCString opt = enable ? "enable" : "disable";

1897 return "click to "+opt+" panel synchronization";

1898 }

trParameters()

QCString TranslatorEnglish::trParameters ()

inline virtual

this text is generated when the \param command is used.

Definition at line 558 of file translator_en.h.

558 QCString trParameters() override

559 { return "Parameters"; }

trPostcondition()

QCString TranslatorEnglish::trPostcondition ()

inline virtual

Text for the \post command

Definition at line 863 of file translator_en.h.

863 QCString trPostcondition() override

864 {

865 return "Postcondition";

866 }

trPrecondition()

QCString TranslatorEnglish::trPrecondition ()

inline virtual

Text for the \pre command

Definition at line 858 of file translator_en.h.

858 QCString trPrecondition() override

859 {

860 return "Precondition";

861 }

trPrivateAttribs()

QCString TranslatorEnglish::trPrivateAttribs ()

inline virtual

Definition at line 942 of file translator_en.h.

942 QCString trPrivateAttribs() override

943 {

944 return "Private Attributes";

945 }

trPrivateMembers()

QCString TranslatorEnglish::trPrivateMembers ()

inline virtual

Definition at line 658 of file translator_en.h.

658 QCString trPrivateMembers() override

659 { return "Private Member Functions"; }

trPrivateSlots()

QCString TranslatorEnglish::trPrivateSlots ()

inline virtual

Definition at line 660 of file translator_en.h.

660 QCString trPrivateSlots() override

661 { return "Private Slots"; }

trPrivateTypes()

QCString TranslatorEnglish::trPrivateTypes ()

inline virtual

Definition at line 938 of file translator_en.h.

938 QCString trPrivateTypes() override

939 {

940 return "Private Types";

941 }

trProperties()

QCString TranslatorEnglish::trProperties ()

inline virtual

Used as a section header for IDL properties

Definition at line 1094 of file translator_en.h.

1094 QCString trProperties() override

1095 {

1096 return "Properties";

1097 }

trPropertyDocumentation()

QCString TranslatorEnglish::trPropertyDocumentation ()

inline virtual

Used as a section header for IDL property documentation

Definition at line 1099 of file translator_en.h.

1099 QCString trPropertyDocumentation() override

1100 {

1101 return "Property Documentation";

1102 }

trProtectedAttribs()

QCString TranslatorEnglish::trProtectedAttribs ()

inline virtual

Definition at line 930 of file translator_en.h.

930 QCString trProtectedAttribs() override

931 {

932 return "Protected Attributes";

933 }

trProtectedMembers()

QCString TranslatorEnglish::trProtectedMembers ()

inline virtual

Definition at line 652 of file translator_en.h.

652 QCString trProtectedMembers() override

653 { return "Protected Member Functions"; }

trProtectedSlots()

QCString TranslatorEnglish::trProtectedSlots ()

inline virtual

Definition at line 654 of file translator_en.h.

654 QCString trProtectedSlots() override

655 { return "Protected Slots"; }

trProtectedTypes()

QCString TranslatorEnglish::trProtectedTypes ()

inline virtual

Definition at line 926 of file translator_en.h.

926 QCString trProtectedTypes() override

927 {

928 return "Protected Types";

929 }

trProvidedByCategory()

QCString TranslatorEnglish::trProvidedByCategory ()

inline virtual

Used in a method of an Objective-C class that is declared in a a category. Note that the @1 marker is required and is replaced by a link.

Definition at line 1904 of file translator_en.h.

1904 QCString trProvidedByCategory() override

1905 {

1906 return "Provided by category @0.";

1907 }

trPublicAttribs()

QCString TranslatorEnglish::trPublicAttribs ()

inline virtual

Definition at line 911 of file translator_en.h.

911 QCString trPublicAttribs() override

912 {

913 if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))

914 {

915 return "Data Fields";

916 }

917 else

918 {

919 return "Public Attributes";

920 }

921 }

Reference Config_getBool.

trPublicMembers()

QCString TranslatorEnglish::trPublicMembers ()

inline virtual

Definition at line 644 of file translator_en.h.

644 QCString trPublicMembers() override

645 { return "Public Member Functions"; }

trPublicSlots()

QCString TranslatorEnglish::trPublicSlots ()

inline virtual

Definition at line 646 of file translator_en.h.

646 QCString trPublicSlots() override

647 { return "Public Slots"; }

trPublicTypes()

QCString TranslatorEnglish::trPublicTypes ()

inline virtual

Definition at line 907 of file translator_en.h.

907 QCString trPublicTypes() override

908 {

909 return "Public Types";

910 }

trReferencedBy()

QCString TranslatorEnglish::trReferencedBy ()

inline virtual

Definition at line 970 of file translator_en.h.

970 QCString trReferencedBy() override

971 {

972 return "Referenced by";

973 }

trReferenceManual()

QCString TranslatorEnglish::trReferenceManual ()

inline virtual

This is used in LaTeX as the title of the document

Definition at line 436 of file translator_en.h.

436 QCString trReferenceManual() override

437 { return "Reference Manual"; }

trReferences()

QCString TranslatorEnglish::trReferences ()

inline virtual

This text is put before the list of members referenced by a member

Definition at line 1285 of file translator_en.h.

1285 QCString trReferences() override

1286 {

1287 return "References";

1288 }

trReimplementedFromList()

QCString TranslatorEnglish::trReimplementedFromList (int numEntries)

inline virtual

used in member documentation blocks to produce a list of members that are hidden by this one.

Definition at line 708 of file translator_en.h.

708 QCString trReimplementedFromList(int numEntries) override

709 {

710 return "Reimplemented from "+trWriteList(numEntries)+".";

711 }

Reference trWriteList.

trReimplementedInList()

QCString TranslatorEnglish::trReimplementedInList (int numEntries)

inline virtual

used in member documentation blocks to produce a list of all member that overwrite the implementation of this member.

Definition at line 716 of file translator_en.h.

716 QCString trReimplementedInList(int numEntries) override

717 {

718 return "Reimplemented in "+trWriteList(numEntries)+".";

719 }

Reference trWriteList.

trRelatedFunctionDocumentation()

QCString TranslatorEnglish::trRelatedFunctionDocumentation ()

inline virtual

used in the class documentation as a header before the list of all related classes

Definition at line 599 of file translator_en.h.

599 QCString trRelatedFunctionDocumentation() override

600 { return "Friends And Related Function Documentation"; }

trRelatedFunctions()

QCString TranslatorEnglish::trRelatedFunctions ()

inline virtual

used in the compound documentation before a list of related functions.

Definition at line 89 of file translator_en.h.

89 QCString trRelatedFunctions() override

90 { return "Related Functions"; }

trRelatedPages()

QCString TranslatorEnglish::trRelatedPages ()

inline virtual

This is put above each page as a link to all related pages.

Definition at line 236 of file translator_en.h.

236 QCString trRelatedPages() override

237 { return "Related Pages"; }

trRelatedPagesDescription()

QCString TranslatorEnglish::trRelatedPagesDescription ()

inline virtual

This is an introduction to the page with the list of related pages

Definition at line 358 of file translator_en.h.

358 QCString trRelatedPagesDescription() override

359 { return "Here is a list of all related documentation pages:"; }

trRelatedSubscript()

QCString TranslatorEnglish::trRelatedSubscript ()

inline virtual

subscript for the related functions.

Definition at line 93 of file translator_en.h.

93 QCString trRelatedSubscript() override

94 { return "(Note that these are not member functions.)"; }

trRelatedSymbolDocumentation()

QCString TranslatorEnglish::trRelatedSymbolDocumentation ()

inline virtual

used in the class documentation as a header before the list of all related classes.

Supersedes trRelatedFunctionDocumentation

Definition at line 2342 of file translator_en.h.

2342 QCString trRelatedSymbolDocumentation() override

2343 { return "Friends And Related Symbol Documentation"; }

trRelatedSymbols()

QCString TranslatorEnglish::trRelatedSymbols ()

inline virtual

Please translate also updated body of the method trMemberFunctionDocumentation(), now better adapted for VHDL sources documentation.

used in the compound documentation before a list of related symbols.

Supersedes trRelatedFunctions

Definition at line 2327 of file translator_en.h.

2327 QCString trRelatedSymbols() override

2328 { return "Related Symbols"; }

trRelatedSymbolsSubscript()

QCString TranslatorEnglish::trRelatedSymbolsSubscript ()

inline virtual

subscript for the related symbols

Supersedes trRelatedSubscript

Definition at line 2334 of file translator_en.h.

2334 QCString trRelatedSymbolsSubscript() override

2335 { return "(Note that these are not member symbols.)"; }

trRemarks()

QCString TranslatorEnglish::trRemarks ()

inline virtual

Definition at line 974 of file translator_en.h.

974 QCString trRemarks() override

975 {

976 return "Remarks";

977 }

trReturns()

QCString TranslatorEnglish::trReturns ()

inline virtual

this text is generated when the \return command is used.

Definition at line 550 of file translator_en.h.

550 QCString trReturns() override

551 { return "Returns"; }

trReturnValues()

QCString TranslatorEnglish::trReturnValues ()

inline virtual

This is used as the heading text for the retval command.

Definition at line 792 of file translator_en.h.

792 QCString trReturnValues() override

793 { return "Return values"; }

trRTFansicp()

QCString TranslatorEnglish::trRTFansicp ()

inline virtual

Used as ansicpg for RTF file

The following table shows the correlation of Charset name, Charset Value and

Codepage number:
Charset Name       Charset Value(hex)  Codepage number
------------------------------------------------------
DEFAULT_CHARSET           1 (x01)
SYMBOL_CHARSET            2 (x02)
OEM_CHARSET             255 (xFF)
ANSI_CHARSET              0 (x00)            1252
RUSSIAN_CHARSET         204 (xCC)            1251
EE_CHARSET              238 (xEE)            1250
GREEK_CHARSET           161 (xA1)            1253
TURKISH_CHARSET         162 (xA2)            1254
BALTIC_CHARSET          186 (xBA)            1257
HEBREW_CHARSET          177 (xB1)            1255
ARABIC _CHARSET         178 (xB2)            1256
SHIFTJIS_CHARSET        128 (x80)             932
HANGEUL_CHARSET         129 (x81)             949
GB2313_CHARSET          134 (x86)             936
CHINESEBIG5_CHARSET     136 (x88)             950

Definition at line 1185 of file translator_en.h.

1185 QCString trRTFansicp() override

1186 {

1187 return "1252";

1188 }

trRTFCharSet()

QCString TranslatorEnglish::trRTFCharSet ()

inline virtual

Used as ansicpg for RTF fcharset

See Also: trRTFansicp() for a table of possible values.

Definition at line 1194 of file translator_en.h.

1194 QCString trRTFCharSet() override

1195 {

1196 return "0";

1197 }

trRTFGeneralIndex()

QCString TranslatorEnglish::trRTFGeneralIndex ()

inline virtual

Used as header RTF general index

Definition at line 1200 of file translator_en.h.

1200 QCString trRTFGeneralIndex() override

1201 {

1202 return "Index";

1203 }

trRTFTableOfContents()

QCString TranslatorEnglish::trRTFTableOfContents ()

inline virtual

used in RTF documentation as a heading for the Table of Contents.

Definition at line 1317 of file translator_en.h.

1317 QCString trRTFTableOfContents() override

1318 {

1319 return "Table of Contents";

1320 }

trSearch()

QCString TranslatorEnglish::trSearch ()

inline virtual

This is put above each page as a link to the search engine.

Definition at line 244 of file translator_en.h.

244 QCString trSearch() override

245 { return "Search"; }

trSearching()

QCString TranslatorEnglish::trSearching ()

inline virtual

Message shown while searching

Definition at line 1751 of file translator_en.h.

1751 QCString trSearching() override

1752 {

1753 return "Searching...";

1754 }

trSearchMatches()

QCString TranslatorEnglish::trSearchMatches ()

inline virtual

This string is put before the list of matched words, for each search result. What follows is the list of words that matched the query.

Definition at line 1449 of file translator_en.h.

1449 QCString trSearchMatches() override

1450 {

1451 return "Matches:";

1452 }

trSearchResults()

QCString TranslatorEnglish::trSearchResults (int numDocuments)

inline virtual

This string is put just before listing the search results. The text can be different depending on the number of documents found. Inside the text you can put the special marker $num to insert the number representing the actual number of search results. The numDocuments parameter can be either 0, 1 or 2, where the value 2 represents 2 or more matches. HTML markup is allowed inside the returned string.

Definition at line 1430 of file translator_en.h.

1430 QCString trSearchResults(int numDocuments) override

1431 {

1432 if (numDocuments==0)

1433 {

1434 return "Sorry, no documents matching your query.";

1435 }

1436 else if (numDocuments==1)

1437 {

1438 return "Found 1 document matching your query.";

1439 }

1440 else

1441 {

1442 return "Found $num documents matching your query. "

1443 "Showing best matches first.";

1444 }

1445 }

trSearchResultsTitle()

QCString TranslatorEnglish::trSearchResultsTitle ()

inline virtual

This string is used as the title for the page listing the search results.

Definition at line 1418 of file translator_en.h.

1418 QCString trSearchResultsTitle() override

1419 {

1420 return "Search Results";

1421 }

trSeeAlso()

QCString TranslatorEnglish::trSeeAlso ()

inline virtual

this text is generated when the \sa command is used.

Definition at line 554 of file translator_en.h.

554 QCString trSeeAlso() override

555 { return "See also"; }

trSequenceDocumentation()

QCString TranslatorEnglish::trSequenceDocumentation ()

inline virtual

Definition at line 2127 of file translator_en.h.

2127 QCString trSequenceDocumentation() override

2128 {

2129 return "Sequence Documentation";

2130 }

trSequences()

QCString TranslatorEnglish::trSequences ()

inline virtual

Definition at line 2123 of file translator_en.h.

2123 QCString trSequences() override

2124 {

2125 return "Sequences";

2126 }

trServiceGeneratedFromFiles()

QCString TranslatorEnglish::trServiceGeneratedFromFiles (bool single)

inline virtual

UNO IDL service page.

Definition at line 1979 of file translator_en.h.

1979 QCString trServiceGeneratedFromFiles(bool single) override

1980 {

1981 // single is true implies a single file

1982 QCString result="The documentation for this service "

1983 "was generated from the following file";

1984 if (single) result+=":"; else result+="s:";

1985 return result;

1986 }

trServiceReference()

QCString TranslatorEnglish::trServiceReference (const QCString & sName)

inline virtual

UNO IDL service page title.

Definition at line 1965 of file translator_en.h.

1965 QCString trServiceReference(const QCString &sName) override

1966 {

1967 QCString result=sName;

1968 result+=" Service Reference";

1969 return result;

1970 }

trServices()

QCString TranslatorEnglish::trServices ()

inline virtual

old style UNO IDL services: inherited services

Definition at line 1950 of file translator_en.h.

1950 QCString trServices() override

1951 { return "Included Services"; }

trSignals()

QCString TranslatorEnglish::trSignals ()

inline virtual

Definition at line 648 of file translator_en.h.

648 QCString trSignals() override

649 { return "Signals"; }

trSince()

QCString TranslatorEnglish::trSince ()

inline virtual

Definition at line 987 of file translator_en.h.

987 QCString trSince() override

988 {

989 return "Since";

990 }

trSingletonGeneratedFromFiles()

QCString TranslatorEnglish::trSingletonGeneratedFromFiles (bool single)

inline virtual

UNO IDL singleton page.

Definition at line 1988 of file translator_en.h.

1988 QCString trSingletonGeneratedFromFiles(bool single) override

1989 {

1990 // single is true implies a single file

1991 QCString result="The documentation for this singleton "

1992 "was generated from the following file";

1993 if (single) result+=":"; else result+="s:";

1994 return result;

1995 }

trSingletonReference()

QCString TranslatorEnglish::trSingletonReference (const QCString & sName)

inline virtual

UNO IDL singleton page title.

Definition at line 1972 of file translator_en.h.

1972 QCString trSingletonReference(const QCString &sName) override

1973 {

1974 QCString result=sName;

1975 result+=" Singleton Reference";

1976 return result;

1977 }

trSliceInterfaces()

QCString TranslatorEnglish::trSliceInterfaces ()

inline virtual

Definition at line 2139 of file translator_en.h.

2139 QCString trSliceInterfaces() override

2140 {

2141 return "Interfaces";

2142 }

trSourceFile()

QCString TranslatorEnglish::trSourceFile (const QCString & filename)

inline virtual

This is used in HTML as the title of page with source code for file filename

Definition at line 1460 of file translator_en.h.

1460 QCString trSourceFile(const QCString& filename) override

1461 {

1462 return filename + " Source File";

1463 }

trStaticPackageAttribs()

QCString TranslatorEnglish::trStaticPackageAttribs ()

inline virtual

Used as a heading for a list of static Java class variables with package scope.

Definition at line 1389 of file translator_en.h.

1389 QCString trStaticPackageAttribs() override

1390 {

1391 return "Static Package Attributes";

1392 }

trStaticPackageFunctions()

QCString TranslatorEnglish::trStaticPackageFunctions ()

inline virtual

Used as a heading for a list of static Java class functions with package scope.

Definition at line 1375 of file translator_en.h.

1375 QCString trStaticPackageFunctions() override

1376 {

1377 return "Static Package Functions";

1378 }

trStaticPrivateAttribs()

QCString TranslatorEnglish::trStaticPrivateAttribs ()

inline virtual

Definition at line 946 of file translator_en.h.

946 QCString trStaticPrivateAttribs() override

947 {

948 return "Static Private Attributes";

949 }

trStaticPrivateMembers()

QCString TranslatorEnglish::trStaticPrivateMembers ()

inline virtual

Definition at line 662 of file translator_en.h.

662 QCString trStaticPrivateMembers() override

663 { return "Static Private Member Functions"; }

trStaticProtectedAttribs()

QCString TranslatorEnglish::trStaticProtectedAttribs ()

inline virtual

Definition at line 934 of file translator_en.h.

934 QCString trStaticProtectedAttribs() override

935 {

936 return "Static Protected Attributes";

937 }

trStaticProtectedMembers()

QCString TranslatorEnglish::trStaticProtectedMembers ()

inline virtual

Definition at line 656 of file translator_en.h.

656 QCString trStaticProtectedMembers() override

657 { return "Static Protected Member Functions"; }

trStaticPublicAttribs()

QCString TranslatorEnglish::trStaticPublicAttribs ()

inline virtual

Definition at line 922 of file translator_en.h.

922 QCString trStaticPublicAttribs() override

923 {

924 return "Static Public Attributes";

925 }

trStaticPublicMembers()

QCString TranslatorEnglish::trStaticPublicMembers ()

inline virtual

Definition at line 650 of file translator_en.h.

650 QCString trStaticPublicMembers() override

651 { return "Static Public Member Functions"; }

trStructDocumentation()

QCString TranslatorEnglish::trStructDocumentation ()

inline virtual

Definition at line 2183 of file translator_en.h.

2183 QCString trStructDocumentation() override

2184 {

2185 return "Struct Documentation";

2186 }

trStructIndex()

QCString TranslatorEnglish::trStructIndex ()

inline virtual

Definition at line 2171 of file translator_en.h.

2171 QCString trStructIndex() override

2172 {

2173 return "Struct Index";

2174 }

trStructList()

QCString TranslatorEnglish::trStructList ()

inline virtual

Definition at line 2175 of file translator_en.h.

2175 QCString trStructList() override

2176 {

2177 return "Struct List";

2178 }

trStructListDescription()

QCString TranslatorEnglish::trStructListDescription ()

inline virtual

Definition at line 2179 of file translator_en.h.

2179 QCString trStructListDescription() override

2180 {

2181 return "Here are the structs with brief descriptions:";

2182 }

trStructs()

QCString TranslatorEnglish::trStructs ()

inline virtual

Definition at line 2167 of file translator_en.h.

2167 QCString trStructs() override

2168 {

2169 return "Structs";

2170 }

trSubprogram()

QCString TranslatorEnglish::trSubprogram (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1717 of file translator_en.h.

1717 QCString trSubprogram(bool first_capital, bool singular) override

1718 {

1719 return createNoun(first_capital, singular, "subprogram", "s");

1720 }

Reference Translator::createNoun.

trSubprogramDocumentation()

QCString TranslatorEnglish::trSubprogramDocumentation ()

inline virtual

This is used in the documentation of a file/namespace before the list of documentation blocks for subprograms (Fortran)

Definition at line 1593 of file translator_en.h.

1593 QCString trSubprogramDocumentation() override

1594 { return "Function/Subroutine Documentation"; }

trSubprograms()

QCString TranslatorEnglish::trSubprograms ()

inline virtual

This is used in the documentation of a file as a header before the list of (global) subprograms (Fortran).

Definition at line 1587 of file translator_en.h.

1587 QCString trSubprograms() override

1588 { return "Functions/Subroutines"; }

trTemplateParameters()

QCString TranslatorEnglish::trTemplateParameters ()

inline virtual

Section header for list of template parameters

Definition at line 1857 of file translator_en.h.

1857 QCString trTemplateParameters() override

1858 { return "Template Parameters"; }

trTest()

QCString TranslatorEnglish::trTest ()

inline virtual

Used as a marker that is put before a test item

Definition at line 1079 of file translator_en.h.

1079 QCString trTest() override

1080 {

1081 return "Test";

1082 }

trTestList()

QCString TranslatorEnglish::trTestList ()

inline virtual

Used as the header of the test list

Definition at line 1084 of file translator_en.h.

1084 QCString trTestList() override

1085 {

1086 return "Test List";

1087 }

trThisIsTheListOfAllMembers()

QCString TranslatorEnglish::trThisIsTheListOfAllMembers ()

inline virtual

this is the first part of a sentence that is followed by a class name

Definition at line 151 of file translator_en.h.

151 QCString trThisIsTheListOfAllMembers() override

152 { return "This is the complete list of members for"; }

trTodo()

QCString TranslatorEnglish::trTodo ()

inline virtual

Used as a marker that is put before a \todo item

Definition at line 956 of file translator_en.h.

956 QCString trTodo() override

957 {

958 return "Todo";

959 }

trTodoList()

QCString TranslatorEnglish::trTodoList ()

inline virtual

Used as the header of the todo list

Definition at line 961 of file translator_en.h.

961 QCString trTodoList() override

962 {

963 return "Todo List";

964 }

trTopicDocumentation()

QCString TranslatorEnglish::trTopicDocumentation ()

inline virtual

Definition at line 2548 of file translator_en.h.

2548 QCString trTopicDocumentation() override

2549 { return "Topic Documentation"; }

trTopicIndex()

QCString TranslatorEnglish::trTopicIndex ()

inline virtual

Definition at line 2552 of file translator_en.h.

2552 QCString trTopicIndex() override

2553 { return "Topic Index"; }

trTopicList()

QCString TranslatorEnglish::trTopicList ()

inline virtual

Definition at line 2550 of file translator_en.h.

2550 QCString trTopicList() override

2551 { return "Topic List"; }

trTopicListDescription()

QCString TranslatorEnglish::trTopicListDescription ()

inline virtual

Definition at line 2554 of file translator_en.h.

2554 QCString trTopicListDescription() override

2555 { return "Here is a list of all topics with brief descriptions:"; }

trTopics()

QCString TranslatorEnglish::trTopics ()

inline virtual

Definition at line 2546 of file translator_en.h.

2546 QCString trTopics() override

2547 { return "Topics"; }

trType()

QCString TranslatorEnglish::trType (bool first_capital, bool singular)

inline virtual

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Definition at line 1708 of file translator_en.h.

1708 QCString trType(bool first_capital, bool singular) override

1709 {

1710 return createNoun(first_capital, singular, "type", "s");

1711 }

Reference Translator::createNoun.

Referenced by trCompoundType.

trTypeConstraints()

QCString TranslatorEnglish::trTypeConstraints ()

inline virtual

C# Type Constraint list

Definition at line 1723 of file translator_en.h.

1723 QCString trTypeConstraints() override

1724 {

1725 return "Type Constraints";

1726 }

trTypedefDocumentation()

QCString TranslatorEnglish::trTypedefDocumentation ()

inline virtual

This is used in the documentation of a file/namespace before the list of documentation blocks for typedefs

Definition at line 484 of file translator_en.h.

484 QCString trTypedefDocumentation() override

485 { return "Typedef Documentation"; }

trTypedefs()

QCString TranslatorEnglish::trTypedefs ()

inline virtual

This is used in the documentation of a file as a header before the list of typedefs

Definition at line 448 of file translator_en.h.

448 QCString trTypedefs() override

449 { return "Typedefs"; }

trTypeDocumentation()

QCString TranslatorEnglish::trTypeDocumentation ()

inline virtual

This is used in LaTeX as the title of the chapter containing the documentation of all data types (Fortran).

Definition at line 1581 of file translator_en.h.

1581 QCString trTypeDocumentation() override

1582 { return "Data Type Documentation"; }

trVariableDocumentation()

QCString TranslatorEnglish::trVariableDocumentation ()

inline virtual

This is used in the documentation of a file/namespace before the list of documentation blocks for variables

Definition at line 502 of file translator_en.h.

502 QCString trVariableDocumentation() override

503 { return "Variable Documentation"; }

trVariables()

QCString TranslatorEnglish::trVariables ()

inline virtual

This is used in the documentation of a file as a header before the list of (global) variables

Definition at line 466 of file translator_en.h.

466 QCString trVariables() override

467 { return "Variables"; }

trVersion()

QCString TranslatorEnglish::trVersion ()

inline virtual

this text is generated when the \version command is used.

Definition at line 542 of file translator_en.h.

542 QCString trVersion() override

543 { return "Version"; }

trVhdlType()

QCString TranslatorEnglish::trVhdlType (VhdlSpecifier type, bool single)

inline virtual

VHDL type.

Definition at line 2026 of file translator_en.h.

2026 QCString trVhdlType(VhdlSpecifier type,bool single) override

2027 {

2028 switch(type)

2029 {

2030 case VhdlSpecifier::LIBRARY:

2031 if (single) return "Library";

2032 else return "Libraries";

2033 case VhdlSpecifier::PACKAGE:

2034 if (single) return "Package";

2035 else return "Packages";

2036 case VhdlSpecifier::SIGNAL:

2037 if (single) return "Signal";

2038 else return "Signals";

2039 case VhdlSpecifier::COMPONENT:

2040 if (single) return "Component";

2041 else return "Components";

2042 case VhdlSpecifier::CONSTANT:

2043 if (single) return "Constant";

2044 else return "Constants";

2045 case VhdlSpecifier::ENTITY:

2046 if (single) return "Entity";

2047 else return "Entities";

2048 case VhdlSpecifier::TYPE:

2049 if (single) return "Type";

2050 else return "Types";

2051 case VhdlSpecifier::SUBTYPE:

2052 if (single) return "Subtype";

2053 else return "Subtypes";

2054 case VhdlSpecifier::FUNCTION:

2055 if (single) return "Function";

2056 else return "Functions";

2057 case VhdlSpecifier::RECORD:

2058 if (single) return "Record";

2059 else return "Records";

2060 case VhdlSpecifier::PROCEDURE:

2061 if (single) return "Procedure";

2062 else return "Procedures";

2063 case VhdlSpecifier::ARCHITECTURE:

2064 if (single) return "Architecture";

2065 else return "Architectures";

2066 case VhdlSpecifier::ATTRIBUTE:

2067 if (single) return "Attribute";

2068 else return "Attributes";

2069 case VhdlSpecifier::PROCESS:

2070 if (single) return "Process";

2071 else return "Processes";

2072 case VhdlSpecifier::PORT:

2073 if (single) return "Port";

2074 else return "Ports";

2075 case VhdlSpecifier::USE:

2076 if (single) return "use clause";

2077 else return "Use Clauses";

2078 case VhdlSpecifier::GENERIC:

2079 if (single) return "Generic";

2080 else return "Generics";

2081 case VhdlSpecifier::PACKAGE_BODY:

2082 return "Package Body";

2083 case VhdlSpecifier::UNITS:

2084 return "Units";

2085 case VhdlSpecifier::SHAREDVARIABLE:

2086 if (single) return "Shared Variable";

2087 else return "Shared Variables";

2088 case VhdlSpecifier::VFILE:

2089 if (single) return "File";

2090 else return "Files";

2091 case VhdlSpecifier::GROUP:

2092 if (single) return "Group";

2093 else return "Groups";

2094 case VhdlSpecifier::INSTANTIATION:

2095 if (single) return "Instantiation";

2096 else return "Instantiations";

2097 case VhdlSpecifier::ALIAS:

2098 if (single) return "Alias";

2099 else return "Aliases";

2100 case VhdlSpecifier::CONFIG:

2101 if (single) return "Configuration";

2102 else return "Configurations";

2103 case VhdlSpecifier::MISCELLANEOUS:

2104 return "Miscellaneous";

2105 case VhdlSpecifier::UCF_CONST:

2106 return "Constraints";

2107 default:

2108 return "Class";

2109 }

2110 }

References ALIAS, ARCHITECTURE, ATTRIBUTE, COMPONENT, CONFIG, CONSTANT, ENTITY, FUNCTION, GENERIC, GROUP, INSTANTIATION, LIBRARY, MISCELLANEOUS, PACKAGE, PACKAGE_BODY, PORT, PROCEDURE, PROCESS, RECORD, SHAREDVARIABLE, SIGNAL, SUBTYPE, TYPE, UCF_CONST, UNITS, USE and VFILE.

trWarning()

QCString TranslatorEnglish::trWarning ()

inline virtual

this text is generated when the \warning command is used.

Definition at line 538 of file translator_en.h.

538 QCString trWarning() override

539 { return "Warning"; }

trWriteList()

QCString TranslatorEnglish::trWriteList (int numEntries)

inline virtual

this function is used to produce a comma-separated list of items. use generateMarker(i) to indicate where item i should be put.

Definition at line 668 of file translator_en.h.

668 QCString trWriteList(int numEntries) override

669 {

670 QCString result;

671 // the inherits list contain `numEntries' classes

672 for (int i=0;i<numEntries;i++)

673 {

674 // use generateMarker to generate placeholders for the class links!

675 result+=generateMarker(i); // generate marker for entry i in the list

676 // (order is left to right)

677

678 if (i!=numEntries-1) // not the last entry, so we need a separator

679 {

680 if (i<numEntries-2) // not the fore last entry

681 result+=", ";

682 else // the fore last entry

683 result+=", and ";

684 }

685 }

686 return result;

687 }

Reference generateMarker.

Referenced by trImplementedFromList, trImplementedInList, trInheritedByList, trInheritsList, trReimplementedFromList and trReimplementedInList.

The documentation for this class was generated from the following file:

translator_en.h

Generated via doxygen2docusaurus by Doxygen 1.14.0.

Declaration
Included Headers
Base class
Derived Classes
Public Member Functions Index
Description
Public Member Functions

Declaration​

Included Headers​

Base class​

Derived Classes​

Public Member Functions Index​

Description​

Public Member Functions​

getLanguageString()​

idLanguage()​

latexLanguageSupportCommand()​

trAdditionalInheritedMembers()​

trAll()​

trAndMore()​

trAttention()​

trAuthor()​

trBug()​

trBugList()​

trCallerGraph()​

trCallGraph()​

trCiteReferences()​

trClass()​

trClassDiagram()​

trClassDocumentation()​

trClasses()​

trClassHierarchy()​

trClassHierarchyDescription()​

trClassMethods()​

trCode()​

trCollaborationDiagram()​

trCompoundIndex()​

trCompoundIndexFortran()​

trCompoundList()​

trCompoundListDescription()​

trCompoundListDescriptionFortran()​

trCompoundListFortran()​

trCompoundMembers()​

trCompoundMembersDescription()​

trCompoundMembersDescriptionFortran()​

trCompoundMembersDescriptionTotal()​

trCompoundMembersFortran()​

trCompoundReference()​

trCompoundReferenceFortran()​

trCompoundReferenceSlice()​

trCompounds()​

trCompoundType()​

trConcept()​

trConceptDefinition()​

trConceptDocumentation()​

trConceptIndex()​

trConceptList()​

trConceptListDescription()​

trConceptReference()​

trConstantDocumentation()​

trConstantGroupReference()​

trConstantGroups()​

trConstants()​

trConstructorDocumentation()​

trCopyright()​

trCopyToClipboard()​

trCustomReference()​

trDataMemberDocumentation()​

trDataMembers()​

trDataTypes()​

trDate()​

trDateTime()​

trDayOfWeek()​

trDayPeriod()​

trDeclaration()​

trDefinedAtLineInSourceFile()​

trDefinedIn()​

trDefinedInSourceFile()​

trDefineDocumentation()​

trDefines()​

trDefineValue()​

trDefinition()​

trDeprecated()​

trDeprecatedList()​

trDesignUnitDocumentation()​

trDesignUnitHierarchy()​

trDesignUnitIndex()​

Declaration

Included Headers

Base class

Derived Classes

Public Member Functions Index

Description

Public Member Functions

getLanguageString()

idLanguage()

latexLanguageSupportCommand()

trAdditionalInheritedMembers()

trAll()

trAndMore()

trAttention()

trAuthor()

trBug()

trBugList()

trCallerGraph()

trCallGraph()

trCiteReferences()

trClass()

trClassDiagram()

trClassDocumentation()

trClasses()

trClassHierarchy()

trClassHierarchyDescription()

trClassMethods()

trCode()

trCollaborationDiagram()

trCompoundIndex()

trCompoundIndexFortran()

trCompoundList()

trCompoundListDescription()

trCompoundListDescriptionFortran()

trCompoundListFortran()

trCompoundMembers()

trCompoundMembersDescription()

trCompoundMembersDescriptionFortran()

trCompoundMembersDescriptionTotal()

trCompoundMembersFortran()

trCompoundReference()

trCompoundReferenceFortran()

trCompoundReferenceSlice()

trCompounds()

trCompoundType()

trConcept()

trConceptDefinition()

trConceptDocumentation()

trConceptIndex()

trConceptList()

trConceptListDescription()

trConceptReference()

trConstantDocumentation()

trConstantGroupReference()

trConstantGroups()

trConstants()

trConstructorDocumentation()

trCopyright()

trCopyToClipboard()

trCustomReference()

trDataMemberDocumentation()

trDataMembers()

trDataTypes()

trDate()

trDateTime()

trDayOfWeek()

trDayPeriod()

trDeclaration()

trDefinedAtLineInSourceFile()

trDefinedIn()

trDefinedInSourceFile()

trDefineDocumentation()

trDefines()

trDefineValue()

trDefinition()

trDeprecated()

trDeprecatedList()

trDesignUnitDocumentation()

trDesignUnitHierarchy()

trDesignUnitIndex()