#include <src/translator_en.h>

Inheritance diagram for TranslatorEnglish:

Collaboration diagram for TranslatorEnglish:

Public Member Functions
QCString	idLanguage () override

QCString	latexLanguageSupportCommand () override

QCString	trISOLang () override

QCString	getLanguageString () override
	language codes for Html help

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.

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

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

QCString	trConstantGroups () override
	UNO IDL constant groups.

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

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

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

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

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

QCString	trDesignUnitHierarchy () override
	VHDL design unit hierarchy.

QCString	trDesignUnitList () override
	VHDL design unit list.

QCString	trDesignUnitMembers () override
	VHDL design unit members.

QCString	trDesignUnitListDescription () override
	VHDL design unit list description.

QCString	trDesignUnitIndex () override
	VHDL design unit index.

QCString	trDesignUnits () override
	VHDL design units.

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

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

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.

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

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

Public Member Functions inherited from Translator
virtual QCString	updateNeededMessage ()

virtual QCString	latexFontenc ()

virtual QCString	latexFont ()

virtual QCString	latexDocumentPre ()

virtual QCString	latexDocumentPost ()

virtual QCString	latexCommandName ()

virtual bool	needsPunctuation ()
	add punctuation at the end of a brief description when needed and supported by the language

Additional Inherited Members
Protected Member Functions inherited from Translator
QCString	p_latexCommandName (const QCString &latexCmd)

QCString	createNoun (bool first_capital, bool singular, const QCString &base, const QCString &plurSuffix, const QCString &singSuffix="")

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

Member Function Documentation

◆ getLanguageString()

QCString TranslatorEnglish::getLanguageString ( )

inlineoverridevirtual

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)

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 82 of file translator_en.h.

    {
      return "0x409 English (United States)";
    }

◆ idLanguage()

QCString TranslatorEnglish::idLanguage ( )

inlineoverridevirtual

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.

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 55 of file translator_en.h.

56 { return "english"; }

◆ latexLanguageSupportCommand()

QCString TranslatorEnglish::latexLanguageSupportCommand ( )

inlineoverridevirtual

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"

or

"\\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.

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 72 of file translator_en.h.

    {
      return "";
    }

◆ trAdditionalInheritedMembers()

QCString TranslatorEnglish::trAdditionalInheritedMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1883 of file translator_en.h.

1884 { return "Additional Inherited Members"; }

◆ trAll()

QCString TranslatorEnglish::trAll ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1401 of file translator_en.h.

    {
      return "All";
    }

◆ trAndMore()

QCString TranslatorEnglish::trAndMore ( const QCString & number )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1861 of file translator_en.h.

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

◆ trAttention()

QCString TranslatorEnglish::trAttention ( )

inlineoverridevirtual

Implements Translator.

Definition at line 978 of file translator_en.h.

    {
      return "Attention";
    }

◆ trAuthor()

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

inlineoverridevirtual

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

Implements Translator.

Definition at line 1274 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "author", "s");
    }

References Translator::createNoun().

◆ trBug()

QCString TranslatorEnglish::trBug ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1146 of file translator_en.h.

    {
      return "Bug";
    }

◆ trBugList()

QCString TranslatorEnglish::trBugList ( )

inlineoverridevirtual

Used as the header of the bug list

Implements Translator.

Definition at line 1151 of file translator_en.h.

    {
      return "Bug List";
    }

◆ trCallerGraph()

QCString TranslatorEnglish::trCallerGraph ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1520 of file translator_en.h.

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

◆ trCallGraph()

QCString TranslatorEnglish::trCallGraph ( )

inlineoverridevirtual

Put in front of the call graph for a function.

Implements Translator.

Definition at line 1406 of file translator_en.h.

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

◆ trCiteReferences()

QCString TranslatorEnglish::trCiteReferences ( )

inlineoverridevirtual

Header for the page with bibliographic citations

Implements Translator.

Definition at line 1837 of file translator_en.h.

1838 { return "Bibliography"; }

◆ trClass()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1209 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "class", "es");
    }

References Translator::createNoun().

Referenced by trCompoundType().

◆ trClassDiagram()

QCString TranslatorEnglish::trClassDiagram ( const QCString & clName )

inlineoverridevirtual

this text is put before a class diagram

Implements Translator.

Definition at line 532 of file translator_en.h.

    {
      return "Inheritance diagram for "+clName+":";
    }

◆ trClassDocumentation()

QCString TranslatorEnglish::trClassDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 413 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structure Documentation";
      }
      else if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
      {
          return trDesignUnitDocumentation();
      }
      else
      {
        return "Class Documentation";
      }
    }

References Config_getBool, and trDesignUnitDocumentation().

◆ trClasses()

QCString TranslatorEnglish::trClasses ( )

inlineoverridevirtual

Used for Java classes in the summary section of Java packages

Implements Translator.

Definition at line 1109 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structures";
      }
      else
      {
        return "Classes";
      }
    }

References Config_getBool.

◆ trClassHierarchy()

QCString TranslatorEnglish::trClassHierarchy ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 189 of file translator_en.h.

190 { return "Class Hierarchy"; }

◆ trClassHierarchyDescription()

QCString TranslatorEnglish::trClassHierarchyDescription ( )

inlineoverridevirtual

This is an introduction to the class hierarchy.

Implements Translator.

Definition at line 248 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
      {
        return "Here is a hierarchical list of all entities:";
      }
      else
      {
        return "This inheritance list is sorted roughly, "
               "but not completely, alphabetically:";
      }
    }

References Config_getBool.

◆ trClassMethods()

QCString TranslatorEnglish::trClassMethods ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1921 of file translator_en.h.

    {
      return "Class Methods";
    }

◆ trCode()

QCString TranslatorEnglish::trCode ( )

inlineoverridevirtual

Text used the source code in the file index

Implements Translator.

Definition at line 878 of file translator_en.h.

    {
      return "code";
    }

◆ trCollaborationDiagram()

QCString TranslatorEnglish::trCollaborationDiagram ( const QCString & clName )

inlineoverridevirtual

this text is put before a collaboration diagram

Implements Translator.

Definition at line 833 of file translator_en.h.

    {
      return "Collaboration diagram for "+clName+":";
    }

◆ trCompoundIndex()

QCString TranslatorEnglish::trCompoundIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 386 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structure Index";
      }
      else
      {
        return "Class Index";
      }
    }

References Config_getBool.

◆ trCompoundIndexFortran()

QCString TranslatorEnglish::trCompoundIndexFortran ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1575 of file translator_en.h.

1576 { return "Data Type Index"; }

◆ trCompoundList()

QCString TranslatorEnglish::trCompoundList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 193 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structures";
      }
      else
      {
        return "Class List";
      }
    }

References Config_getBool.

◆ trCompoundListDescription()

QCString TranslatorEnglish::trCompoundListDescription ( )

inlineoverridevirtual

This is an introduction to the annotated compound list.

Implements Translator.

Definition at line 271 of file translator_en.h.

    {
 
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Here are the data structures with brief descriptions:";
      }
      else if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
      {
        return "Here are the classes with brief descriptions:";
      }
      else
      {
        return "Here are the classes, structs, "
               "unions and interfaces with brief descriptions:";
      }
    }

References Config_getBool.

◆ trCompoundListDescriptionFortran()

QCString TranslatorEnglish::trCompoundListDescriptionFortran ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1548 of file translator_en.h.

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

◆ trCompoundListFortran()

QCString TranslatorEnglish::trCompoundListFortran ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1540 of file translator_en.h.

1541 { return "Data Types List"; }

◆ trCompoundMembers()

QCString TranslatorEnglish::trCompoundMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 210 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Fields";
      }
      else
      {
        return "Class Members";
      }
    }

References Config_getBool.

◆ trCompoundMembersDescription()

QCString TranslatorEnglish::trCompoundMembersDescription ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 290 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll)
      {
        result+="documented ";
      }
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        result+="struct and union fields";
      }
      else
      {
        result+="class members";
      }
      result+=" with links to ";
      if (!extractAll)
      {
        if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
        {
          result+="the struct/union documentation for each field:";
        }
        else
        {
          result+="the class documentation for each member:";
        }
      }
      else
      {
        if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
        {
          result+="the structures/unions they belong to:";
        }
        else
        {
          result+="the classes they belong to:";
        }
      }
      return result;
    }

References Config_getBool.

◆ trCompoundMembersDescriptionFortran()

QCString TranslatorEnglish::trCompoundMembersDescriptionFortran ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1552 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll)
      {
        result+="documented ";
      }
      result+="data types members";
      result+=" with links to ";
      if (!extractAll)
      {
         result+="the data structure documentation for each member";
      }
      else
      {
         result+="the data types they belong to:";
      }
      return result;
    }

◆ trCompoundMembersDescriptionTotal()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2420 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      QCString result="Here is a list of all ";
      if (!extractAll)
      {
        result+="documented ";
      }
 
      switch (hl)
      {
        case ClassMemberHighlight::All:
          if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
          {
            result+="struct and union fields";
          }
          else
          {
            result+="class members";
          }
          break;
        case ClassMemberHighlight::Functions:
          result+="functions";
          break;
        case ClassMemberHighlight::Variables:
          result+="variables";
          break;
        case ClassMemberHighlight::Typedefs:
          result+="typedefs";
          break;
        case ClassMemberHighlight::Enums:
          result+="enums";
          break;
        case ClassMemberHighlight::EnumValues:
          result+="enum values";
          break;
        case ClassMemberHighlight::Properties:
          result+="properties";
          break;
        case ClassMemberHighlight::Events:
          result+="events";
          break;
        case ClassMemberHighlight::Related:
          result+="related symbols";
          break;
        case ClassMemberHighlight::Total: // for completeness
          break;
      }
      result+=" with links to ";
      if (!extractAll)
      {
        if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
        {
          result+="the struct/union documentation for each field:";
        }
        else
        {
          result+="the class documentation for each member:";
        }
      }
      else
      {
        if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
        {
          result+="the structures/unions they belong to:";
        }
        else
        {
          result+="the classes they belong to:";
        }
      }
      return result;
    }

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

inlineoverridevirtual

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

Implements Translator.

Definition at line 1544 of file translator_en.h.

1545 { return "Data Fields"; }

◆ trCompoundReference()

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

inlineoverridevirtual

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

Implements Translator.

Definition at line 607 of file translator_en.h.

    {
      QCString result=clName;
      switch(compType)
      {
        case ClassDef::Class:      result+=" Class"; break;
        case ClassDef::Struct:     result+=" Struct"; break;
        case ClassDef::Union:      result+=" Union"; break;
        case ClassDef::Interface:  result+=" Interface"; break;
        case ClassDef::Protocol:   result+=" Protocol"; break;
        case ClassDef::Category:   result+=" Category"; break;
        case ClassDef::Exception:  result+=" Exception"; break;
        default: break;
      }
      if (isTemplate) result+=" Template";
      result+=" Reference";
      return result;
    }

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 )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1616 of file translator_en.h.

    {
      QCString result=clName;
      switch(compType)
      {
        case ClassDef::Class:      result+=" Module"; break;
        case ClassDef::Struct:     result+=" Type"; break;
        case ClassDef::Union:      result+=" Union"; break;
        case ClassDef::Interface:  result+=" Interface"; break;
        case ClassDef::Protocol:   result+=" Protocol"; break;
        case ClassDef::Category:   result+=" Category"; break;
        case ClassDef::Exception:  result+=" Exception"; break;
        default: break;
      }
      if (isTemplate) result+=" Template";
      result+=" Reference";
      return result;
    }

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 )

inlineoverridevirtual

Implements Translator.

Definition at line 2211 of file translator_en.h.

    {
      QCString result=clName;
      if (isLocal) result+=" Local";
      switch(compType)
      {
        case ClassDef::Class:      result+=" Class"; break;
        case ClassDef::Struct:     result+=" Struct"; break;
        case ClassDef::Union:      result+=" Union"; break;
        case ClassDef::Interface:  result+=" Interface"; break;
        case ClassDef::Protocol:   result+=" Protocol"; break;
        case ClassDef::Category:   result+=" Category"; break;
        case ClassDef::Exception:  result+=" Exception"; break;
        default: break;
      }
      result+=" Reference";
      return result;
    }

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

◆ trCompounds()

QCString TranslatorEnglish::trCompounds ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 508 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structures";
      }
      else
      {
        return "Classes";
      }
    }

References Config_getBool.

◆ trCompoundType()

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

inlineoverridevirtual

the compound type as used for the xrefitems

Implements Translator.

Definition at line 2346 of file translator_en.h.

    {
      QCString result;
      switch(compType)
      {
        case ClassDef::Class:
          if (lang == SrcLangExt::Fortran) trType(true,true);
          else result=trClass(true,true);
          break;
        case ClassDef::Struct:     result="Struct"; break;
        case ClassDef::Union:      result="Union"; break;
        case ClassDef::Interface:  result="Interface"; break;
        case ClassDef::Protocol:   result="Protocol"; break;
        case ClassDef::Category:   result="Category"; break;
        case ClassDef::Exception:  result="Exception"; break;
        case ClassDef::Service:    result="Service"; break;
        case ClassDef::Singleton:  result="Singleton"; break;
        default: break;
      }
      return result;
    }

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

◆ trConcept()

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

inlineoverridevirtual

C++20 concept.

Implements Translator.

Definition at line 2259 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "concept", "s");
    }

References Translator::createNoun().

◆ trConceptDefinition()

QCString TranslatorEnglish::trConceptDefinition ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2293 of file translator_en.h.

    {
      return "Concept definition";
    }

◆ trConceptDocumentation()

QCString TranslatorEnglish::trConceptDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2280 of file translator_en.h.

2281 { return "Concept Documentation"; }

◆ trConceptIndex()

QCString TranslatorEnglish::trConceptIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2276 of file translator_en.h.

2277 { return "Concept Index"; }

◆ trConceptList()

QCString TranslatorEnglish::trConceptList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2272 of file translator_en.h.

2273 { return "Concept List"; }

◆ trConceptListDescription()

QCString TranslatorEnglish::trConceptListDescription ( bool extractAll )

inlineoverridevirtual

used as an introduction to the concept list

Implements Translator.

Definition at line 2284 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="concepts with brief descriptions:";
      return result;
    }

◆ trConceptReference()

QCString TranslatorEnglish::trConceptReference ( const QCString & conceptName )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2264 of file translator_en.h.

    {
      QCString result=conceptName;
      result+=" Concept Reference";
      return result;
    }

◆ trConstantDocumentation()

QCString TranslatorEnglish::trConstantDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2119 of file translator_en.h.

    {
        return "Constant Documentation";
    }

◆ trConstantGroupReference()

QCString TranslatorEnglish::trConstantGroupReference ( const QCString & namespaceName )

inlineoverridevirtual

UNO IDL constant groups.

Implements Translator.

Definition at line 1958 of file translator_en.h.

    {
      QCString result=namespaceName;
      result+=" Constant Group Reference";
      return result;
    }

◆ trConstantGroups()

QCString TranslatorEnglish::trConstantGroups ( )

inlineoverridevirtual

UNO IDL constant groups.

Implements Translator.

Definition at line 1954 of file translator_en.h.

1955 { return "Constant Groups"; }

◆ trConstants()

QCString TranslatorEnglish::trConstants ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2115 of file translator_en.h.

    {
        return "Constants";
    }

◆ trConstructorDocumentation()

QCString TranslatorEnglish::trConstructorDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 843 of file translator_en.h.

    {
      return "Constructor & Destructor Documentation";
    }

◆ trCopyright()

QCString TranslatorEnglish::trCopyright ( )

inlineoverridevirtual

Text for copyright paragraph

Implements Translator.

Definition at line 1841 of file translator_en.h.

1842 { return "Copyright"; }

◆ trCopyToClipboard()

QCString TranslatorEnglish::trCopyToClipboard ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2604 of file translator_en.h.

    {
      return "Copy to clipboard";
    }

◆ trCustomReference()

QCString TranslatorEnglish::trCustomReference ( const QCString & name )

inlineoverridevirtual

Implements Translator.

Definition at line 2111 of file translator_en.h.

2112 { return name+" Reference"; }

◆ trDataMemberDocumentation()

QCString TranslatorEnglish::trDataMemberDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2241 of file translator_en.h.

    {
        return "Data Member Documentation";
    }

◆ trDataMembers()

QCString TranslatorEnglish::trDataMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2237 of file translator_en.h.

    {
        return "Data Members";
    }

◆ trDataTypes()

QCString TranslatorEnglish::trDataTypes ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1599 of file translator_en.h.

1600 { return "Data Types"; }

◆ trDate()

QCString TranslatorEnglish::trDate ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 546 of file translator_en.h.

547 { return "Date"; }

◆ trDateTime()

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

inlineoverridevirtual

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?

Implements Translator.

Definition at line 1794 of file translator_en.h.

    {
      static const char *days[]   = { "Mon","Tue","Wed","Thu","Fri","Sat","Sun" };
      static const char *months[] = { "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec" };
      QCString sdate;
      if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Date)
      {
        sdate.sprintf("%s %s %d %d",days[dayOfWeek-1],months[month-1],day,year);
      }
      if (includeTime == DateTimeType::DateTime) sdate += " ";
      if (includeTime == DateTimeType::DateTime || includeTime == DateTimeType::Time)
      {
        QCString stime;
        stime.sprintf("%.2d:%.2d:%.2d",hour,minutes,seconds);
        sdate+=stime;
      }
      return sdate;
    }

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

◆ trDayOfWeek()

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

inlineoverridevirtual

Implements Translator.

Definition at line 1814 of file translator_en.h.

    {
      static const char *days_short[]   = { "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" };
      static const char *days_full[]    = { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" };
      return full? days_full[dayOfWeek-1] : days_short[dayOfWeek-1];
    }

◆ trDayPeriod()

QCString TranslatorEnglish::trDayPeriod ( bool period )

inlineoverridevirtual

Implements Translator.

Definition at line 1826 of file translator_en.h.

    {
      static const char *dayPeriod[] = { "AM", "PM" };
      return dayPeriod[period?1:0];
    }

◆ trDeclaration()

QCString TranslatorEnglish::trDeclaration ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2540 of file translator_en.h.

2540{ return "Declaration";}

◆ trDefinedAtLineInSourceFile()

QCString TranslatorEnglish::trDefinedAtLineInSourceFile ( )

inlineoverridevirtual

Implements Translator.

Definition at line 810 of file translator_en.h.

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

◆ trDefinedIn()

QCString TranslatorEnglish::trDefinedIn ( )

inlineoverridevirtual

put after an undocumented member in the list of all members

Implements Translator.

Definition at line 177 of file translator_en.h.

178 { return "defined in"; }

◆ trDefinedInSourceFile()

QCString TranslatorEnglish::trDefinedInSourceFile ( )

inlineoverridevirtual

Implements Translator.

Definition at line 814 of file translator_en.h.

    {
      return "Definition in file @0.";
    }

◆ trDefineDocumentation()

QCString TranslatorEnglish::trDefineDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 478 of file translator_en.h.

479 { return "Macro Definition Documentation"; }

◆ trDefines()

QCString TranslatorEnglish::trDefines ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 442 of file translator_en.h.

443 { return "Macros"; }

◆ trDefineValue()

QCString TranslatorEnglish::trDefineValue ( )

inlineoverridevirtual

Text shown before a multi-line define

Implements Translator.

Definition at line 1136 of file translator_en.h.

    {
      return "Value:";
    }

◆ trDefinition()

QCString TranslatorEnglish::trDefinition ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2539 of file translator_en.h.

2539{ return "Definition";}

◆ trDeprecated()

QCString TranslatorEnglish::trDeprecated ( )

inlineoverridevirtual

Implements Translator.

Definition at line 823 of file translator_en.h.

    {
      return "Deprecated";
    }

◆ trDeprecatedList()

QCString TranslatorEnglish::trDeprecatedList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1329 of file translator_en.h.

    {
      return "Deprecated List";
    }

◆ trDesignUnitDocumentation()

QCString TranslatorEnglish::trDesignUnitDocumentation ( )

inlineoverridevirtual

VHDL design unit documentation.

Implements Translator.

Definition at line 2251 of file translator_en.h.

2252 { return "Design Unit Documentation"; }

Referenced by trClassDocumentation().

◆ trDesignUnitHierarchy()

QCString TranslatorEnglish::trDesignUnitHierarchy ( )

inlineoverridevirtual

VHDL design unit hierarchy.

Implements Translator.

Definition at line 2002 of file translator_en.h.

2003 { return "Design Unit Hierarchy"; }

◆ trDesignUnitIndex()

QCString TranslatorEnglish::trDesignUnitIndex ( )

inlineoverridevirtual

VHDL design unit index.

Implements Translator.

Definition at line 2017 of file translator_en.h.

2018 { return "Design Unit Index"; }

◆ trDesignUnitList()

QCString TranslatorEnglish::trDesignUnitList ( )

inlineoverridevirtual

VHDL design unit list.

Implements Translator.

Definition at line 2005 of file translator_en.h.

2006 { return "Design Unit List"; }

◆ trDesignUnitListDescription()

QCString TranslatorEnglish::trDesignUnitListDescription ( )

inlineoverridevirtual

VHDL design unit list description.

Implements Translator.

Definition at line 2011 of file translator_en.h.

    {
        return "Here is a list of all design unit members with links to "
            "the Entities they belong to:";
    }

◆ trDesignUnitMembers()

QCString TranslatorEnglish::trDesignUnitMembers ( )

inlineoverridevirtual

VHDL design unit members.

Implements Translator.

Definition at line 2008 of file translator_en.h.

2009 { return "Design Unit Members"; }

◆ trDesignUnits()

QCString TranslatorEnglish::trDesignUnits ( )

inlineoverridevirtual

VHDL design units.

Implements Translator.

Definition at line 2020 of file translator_en.h.

2021 { return "Design Units"; }

◆ trDetailedDescription()

QCString TranslatorEnglish::trDetailedDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 97 of file translator_en.h.

98 { return "Detailed Description"; }

◆ trDetailLevel()

QCString TranslatorEnglish::trDetailLevel ( )

inlineoverridevirtual

Detail level selector shown for hierarchical indices

Implements Translator.

Definition at line 1853 of file translator_en.h.

1854 { return "detail level"; }

◆ trDetails()

QCString TranslatorEnglish::trDetails ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 101 of file translator_en.h.

102 { return "Details"; }

◆ trDictionaries()

QCString TranslatorEnglish::trDictionaries ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2131 of file translator_en.h.

    {
        return "Dictionaries";
    }

◆ trDictionaryDocumentation()

QCString TranslatorEnglish::trDictionaryDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2135 of file translator_en.h.

    {
        return "Dictionary Documentation";
    }

◆ trDir()

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

inlineoverridevirtual

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

Implements Translator.

Definition at line 1496 of file translator_en.h.

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

References Translator::createNoun().

◆ trDirDepGraph()

QCString TranslatorEnglish::trDirDepGraph ( const QCString & name )

inlineoverridevirtual

Header for the graph showing the directory dependencies

Implements Translator.

Definition at line 1845 of file translator_en.h.

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

◆ trDirDocumentation()

QCString TranslatorEnglish::trDirDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1478 of file translator_en.h.

1479 { return "Directory Documentation"; }

◆ trDirectories()

QCString TranslatorEnglish::trDirectories ( )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1484 of file translator_en.h.

1485 { return "Directories"; }

◆ trDirIndex()

QCString TranslatorEnglish::trDirIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1472 of file translator_en.h.

1473 { return "Directory Hierarchy"; }

◆ trDirReference()

QCString TranslatorEnglish::trDirReference ( const QCString & dirName )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1490 of file translator_en.h.

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

◆ trDirRelation()

QCString TranslatorEnglish::trDirRelation ( const QCString & name )

inlineoverridevirtual

directory relation for name

Implements Translator.

Definition at line 1733 of file translator_en.h.

    {
      return name+" Relation";
    }

◆ trDocumentation()

QCString TranslatorEnglish::trDocumentation ( const QCString & projName )

inlineoverridevirtual

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

Implements Translator.

Definition at line 368 of file translator_en.h.

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

QCString::isEmpty

bool isEmpty() const

Returns TRUE iff the string is empty.

Definition qcstring.h:150

References QCString::isEmpty().

◆ trEnumerations()

QCString TranslatorEnglish::trEnumerations ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 454 of file translator_en.h.

455 { return "Enumerations"; }

◆ trEnumerationTypeDocumentation()

QCString TranslatorEnglish::trEnumerationTypeDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 490 of file translator_en.h.

491 { return "Enumeration Type Documentation"; }

◆ trEnumerationValueDocumentation()

QCString TranslatorEnglish::trEnumerationValueDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1528 of file translator_en.h.

1529 { return "Enumerator Documentation"; }

◆ trEnumerationValues()

QCString TranslatorEnglish::trEnumerationValues ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 472 of file translator_en.h.

473 { return "Enumerator"; }

◆ trEnumGeneratedFromFiles()

QCString TranslatorEnglish::trEnumGeneratedFromFiles ( bool single )

inlineoverridevirtual

Used file list for a Java enum

Implements Translator.

Definition at line 1865 of file translator_en.h.

    { QCString result = "The documentation for this enum was generated from the following file";
      if (!single) result += "s";
      result+=":";
      return result;
    }

◆ trEnumName()

QCString TranslatorEnglish::trEnumName ( )

inlineoverridevirtual

put after an enum name in the list of all members

Implements Translator.

Definition at line 169 of file translator_en.h.

170 { return "enum name"; }

◆ trEnumReference()

QCString TranslatorEnglish::trEnumReference ( const QCString & name )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1873 of file translator_en.h.

1874 { return name+" Enum Reference"; }

◆ trEnumValue()

QCString TranslatorEnglish::trEnumValue ( )

inlineoverridevirtual

put after an enum value in the list of all members

Implements Translator.

Definition at line 173 of file translator_en.h.

174 { return "enum value"; }

◆ trEventDocumentation()

QCString TranslatorEnglish::trEventDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1346 of file translator_en.h.

    {
      return "Event Documentation";
    }

◆ trEvents()

QCString TranslatorEnglish::trEvents ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1341 of file translator_en.h.

    {
      return "Events";
    }

◆ trExamples()

QCString TranslatorEnglish::trExamples ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 240 of file translator_en.h.

241 { return "Examples"; }

◆ trExamplesDescription()

QCString TranslatorEnglish::trExamplesDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 354 of file translator_en.h.

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

◆ trExceptionDocumentation()

QCString TranslatorEnglish::trExceptionDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2207 of file translator_en.h.

    {
        return "Exception Documentation";
    }

◆ trExceptionHierarchy()

QCString TranslatorEnglish::trExceptionHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2199 of file translator_en.h.

    {
        return "Exception Hierarchy";
    }

◆ trExceptionHierarchyDescription()

QCString TranslatorEnglish::trExceptionHierarchyDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2203 of file translator_en.h.

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

◆ trExceptionIndex()

QCString TranslatorEnglish::trExceptionIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2187 of file translator_en.h.

    {
        return "Exception Index";
    }

◆ trExceptionList()

QCString TranslatorEnglish::trExceptionList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2191 of file translator_en.h.

    {
        return "Exception List";
    }

◆ trExceptionListDescription()

QCString TranslatorEnglish::trExceptionListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2195 of file translator_en.h.

    {
        return "Here are the exceptions with brief descriptions:";
    }

◆ trExceptions()

QCString TranslatorEnglish::trExceptions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 562 of file translator_en.h.

563 { return "Exceptions"; }

◆ trExportedModules()

QCString TranslatorEnglish::trExportedModules ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2595 of file translator_en.h.

    {
      return "Exported Modules";
    }

◆ trExtendsClass()

QCString TranslatorEnglish::trExtendsClass ( )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1913 of file translator_en.h.

    {
      return "Extends class @0.";
    }

◆ trFile()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1218 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "file", "s");
    }

References Translator::createNoun().

◆ trFileDocumentation()

QCString TranslatorEnglish::trFileDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 432 of file translator_en.h.

433 { return "File Documentation"; }

◆ trFileIn()

QCString TranslatorEnglish::trFileIn ( const QCString & name )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1770 of file translator_en.h.

    {
      return "File in "+name;
    }

◆ trFileIndex()

QCString TranslatorEnglish::trFileIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 401 of file translator_en.h.

402 { return "File Index"; }

◆ trFileList()

QCString TranslatorEnglish::trFileList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 206 of file translator_en.h.

207 { return "File List"; }

◆ trFileListDescription()

QCString TranslatorEnglish::trFileListDescription ( bool extractAll )

inlineoverridevirtual

This is an introduction to the list with all files.

Implements Translator.

Definition at line 262 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="files with brief descriptions:";
      return result;
    }

◆ trFileMembers()

QCString TranslatorEnglish::trFileMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 223 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Globals";
      }
      else
      {
        return "File Members";
      }
    }

References Config_getBool.

◆ trFileMembersDescription()

QCString TranslatorEnglish::trFileMembersDescription ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 332 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
 
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        result+="functions, variables, defines, enums, and typedefs";
      }
      else
      {
        result+="file members";
      }
      result+=" with links to ";
      if (extractAll)
        result+="the files they belong to:";
      else
        result+="the documentation:";
      return result;
    }

References Config_getBool.

◆ trFileMembersDescriptionTotal()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2368 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
 
      switch (hl)
      {
        case FileMemberHighlight::All:
          if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
          {
            result+="functions, variables, defines, enums, and typedefs";
          }
          else
          {
            result+="file members";
          }
          break;
        case FileMemberHighlight::Functions:
          result+="functions";
          break;
        case FileMemberHighlight::Variables:
          result+="variables";
          break;
        case FileMemberHighlight::Typedefs:
          result+="typedefs";
          break;
        case FileMemberHighlight::Sequences:
          result+="sequences";
          break;
        case FileMemberHighlight::Dictionaries:
          result+="dictionaries";
          break;
        case FileMemberHighlight::Enums:
          result+="enums";
          break;
        case FileMemberHighlight::EnumValues:
          result+="enum values";
          break;
        case FileMemberHighlight::Defines:
          result+="macros";
          break;
        case FileMemberHighlight::Total: // for completeness
          break;
      }
      result+=" with links to ";
      if (extractAll)
        result+="the files they belong to:";
      else
        result+="the documentation:";
      return result;
    }

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 )

inlineoverridevirtual

used as the title of the HTML page of a file

Implements Translator.

Definition at line 629 of file translator_en.h.

    {
      QCString result=fileName;
      result+=" File Reference";
      return result;
    }

◆ trFlowchart()

QCString TranslatorEnglish::trFlowchart ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2312 of file translator_en.h.

2313 { return "Flowchart:"; }

◆ trFriends()

QCString TranslatorEnglish::trFriends ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 589 of file translator_en.h.

590 { return "Friends"; }

◆ trFunctionAndProc()

QCString TranslatorEnglish::trFunctionAndProc ( )

inlineoverridevirtual

VHDL functions/procedures/processes.

Implements Translator.

Definition at line 2023 of file translator_en.h.

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

◆ trFunctionDocumentation()

QCString TranslatorEnglish::trFunctionDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 496 of file translator_en.h.

497 { return "Function Documentation"; }

◆ trFunctions()

QCString TranslatorEnglish::trFunctions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 460 of file translator_en.h.

461 { return "Functions"; }

◆ trGeneratedAt()

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

inlineoverridevirtual

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

Implements Translator.

Definition at line 523 of file translator_en.h.

    {
      QCString result="Generated on "+date;
      if (!projName.isEmpty()) result+=" for "+projName;
      result+=" by";
      return result;
    }

References QCString::isEmpty().

◆ trGeneratedAutomatically()

QCString TranslatorEnglish::trGeneratedAutomatically ( const QCString & s )

inlineoverridevirtual

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

Implements Translator.

Definition at line 161 of file translator_en.h.

    { QCString result="Generated automatically by Doxygen";
      if (!s.isEmpty()) result+=" for "+s;
      result+=" from the source code.";
      return result;
    }

References QCString::isEmpty().

◆ trGeneratedBy()

QCString TranslatorEnglish::trGeneratedBy ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 566 of file translator_en.h.

567 { return "Generated by"; }

◆ trGeneratedFromFiles()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 766 of file translator_en.h.

    { // single is true implies a single file
      bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
      QCString result="The documentation for this ";
      switch(compType)
      {
        case ClassDef::Class:      result+=vhdlOpt?"design unit":"class"; break;
        case ClassDef::Struct:     result+="struct"; break;
        case ClassDef::Union:      result+="union"; break;
        case ClassDef::Interface:  result+="interface"; break;
        case ClassDef::Protocol:   result+="protocol"; break;
        case ClassDef::Category:   result+="category"; break;
        case ClassDef::Exception:  result+="exception"; break;
        default: break;
      }
      result+=" was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }

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 )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1683 of file translator_en.h.

    {
      // single is true implies a single file
      QCString result="The documentation for this ";
      switch(compType)
      {
        case ClassDef::Class:      result+="module"; break;
        case ClassDef::Struct:     result+="type"; break;
        case ClassDef::Union:      result+="union"; break;
        case ClassDef::Interface:  result+="interface"; break;
        case ClassDef::Protocol:   result+="protocol"; break;
        case ClassDef::Category:   result+="category"; break;
        case ClassDef::Exception:  result+="exception"; break;
        default: break;
      }
      result+=" was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }

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 )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1263 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "global", "s");
    }

References Translator::createNoun().

◆ trGlobalNamespace()

QCString TranslatorEnglish::trGlobalNamespace ( )

inlineoverridevirtual

Label used for search results in the global namespace

Implements Translator.

Definition at line 1745 of file translator_en.h.

    {
      return "Global Namespace";
    }

◆ trGotoDocumentation()

QCString TranslatorEnglish::trGotoDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 853 of file translator_en.h.

    {
      return "Go to the documentation of this file.";
    }

◆ trGotoGraphicalHierarchy()

QCString TranslatorEnglish::trGotoGraphicalHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 886 of file translator_en.h.

    {
      return "Go to the graphical class hierarchy";
    }

◆ trGotoSourceCode()

QCString TranslatorEnglish::trGotoSourceCode ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 848 of file translator_en.h.

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

◆ trGotoTextualHierarchy()

QCString TranslatorEnglish::trGotoTextualHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 890 of file translator_en.h.

    {
      return "Go to the textual class hierarchy";
    }

◆ trGraphicalHierarchy()

QCString TranslatorEnglish::trGraphicalHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 882 of file translator_en.h.

    {
      return "Graphical Class Hierarchy";
    }

◆ trGroup()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1236 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "module", "s");
    }

References Translator::createNoun().

◆ trHierarchicalIndex()

QCString TranslatorEnglish::trHierarchicalIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 380 of file translator_en.h.

381 { return "Hierarchical Index"; }

◆ trImplementedFromList()

QCString TranslatorEnglish::trImplementedFromList ( int numEntries )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1297 of file translator_en.h.

    {
      return "Implements "+trWriteList(numEntries)+".";
    }

References trWriteList().

◆ trImplementedInList()

QCString TranslatorEnglish::trImplementedInList ( int numEntries )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1305 of file translator_en.h.

    {
      return "Implemented in "+trWriteList(numEntries)+".";
    }

References trWriteList().

◆ trImportant()

QCString TranslatorEnglish::trImportant ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2611 of file translator_en.h.

    {
      return "Important";
    }

◆ trInclByDepGraph()

QCString TranslatorEnglish::trInclByDepGraph ( )

inlineoverridevirtual

Implements Translator.

Definition at line 982 of file translator_en.h.

    {
      return "This graph shows which files directly or "
             "indirectly include this file:";
    }

◆ trInclDepGraph()

QCString TranslatorEnglish::trInclDepGraph ( const QCString & fName )

inlineoverridevirtual

this text is put before an include dependency graph

Implements Translator.

Definition at line 838 of file translator_en.h.

    {
      return "Include dependency graph for "+fName+":";
    }

◆ trIncludesFileIn()

QCString TranslatorEnglish::trIncludesFileIn ( const QCString & name )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1779 of file translator_en.h.

    {
      return "Includes file in "+name;
    }

◆ trIncludingInheritedMembers()

QCString TranslatorEnglish::trIncludingInheritedMembers ( )

inlineoverridevirtual

this is the remainder of the sentence after the class name

Implements Translator.

Definition at line 155 of file translator_en.h.

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

◆ trInheritedByList()

QCString TranslatorEnglish::trInheritedByList ( int numEntries )

inlineoverridevirtual

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

Implements Translator.

Definition at line 700 of file translator_en.h.

    {
      return "Inherited by "+trWriteList(numEntries)+".";
    }

References trWriteList().

◆ trInheritedFrom()

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

inlineoverridevirtual

Used for a section containing inherited members

Implements Translator.

Definition at line 1877 of file translator_en.h.

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

◆ trInheritsList()

QCString TranslatorEnglish::trInheritsList ( int numEntries )

inlineoverridevirtual

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

Implements Translator.

Definition at line 692 of file translator_en.h.

    {
      return "Inherits "+trWriteList(numEntries)+".";
    }

References trWriteList().

◆ trInitialValue()

QCString TranslatorEnglish::trInitialValue ( )

inlineoverridevirtual

Text shown before a multi-line variable/enum initialization

Implements Translator.

Definition at line 873 of file translator_en.h.

    {
      return "Initial value:";
    }

◆ trInstanceMethods()

QCString TranslatorEnglish::trInstanceMethods ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1929 of file translator_en.h.

    {
      return "Instance Methods";
    }

◆ trInterfaceDocumentation()

QCString TranslatorEnglish::trInterfaceDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2163 of file translator_en.h.

    {
        return "Interface Documentation";
    }

◆ trInterfaceHierarchy()

QCString TranslatorEnglish::trInterfaceHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2155 of file translator_en.h.

    {
        return "Interface Hierarchy";
    }

◆ trInterfaceHierarchyDescription()

QCString TranslatorEnglish::trInterfaceHierarchyDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2159 of file translator_en.h.

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

◆ trInterfaceIndex()

QCString TranslatorEnglish::trInterfaceIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2143 of file translator_en.h.

    {
        return "Interface Index";
    }

◆ trInterfaceList()

QCString TranslatorEnglish::trInterfaceList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2147 of file translator_en.h.

    {
        return "Interface List";
    }

◆ trInterfaceListDescription()

QCString TranslatorEnglish::trInterfaceListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2151 of file translator_en.h.

    {
        return "Here are the interfaces with brief descriptions:";
    }

◆ trInterfaces()

QCString TranslatorEnglish::trInterfaces ( )

inlineoverridevirtual

old style UNO IDL services: implemented interfaces

Implements Translator.

Definition at line 1946 of file translator_en.h.

1947 { return "Exported Interfaces"; }

◆ trInvariant()

QCString TranslatorEnglish::trInvariant ( )

inlineoverridevirtual

Text for the \invariant command

Implements Translator.

Definition at line 868 of file translator_en.h.

    {
      return "Invariant";
    }

◆ trISOLang()

QCString TranslatorEnglish::trISOLang ( )

inlineoverridevirtual

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 77 of file translator_en.h.

    {
      return "en-US";
    }

◆ trLegend()

QCString TranslatorEnglish::trLegend ( )

inlineoverridevirtual

text for the link to the legend page

Implements Translator.

Definition at line 1069 of file translator_en.h.

    {
      return "legend";
    }

◆ trLegendDocs()

QCString TranslatorEnglish::trLegendDocs ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1004 of file translator_en.h.

    {
      return
        "This page explains how to interpret the graphs that are generated "
        "by doxygen.<p>\n"
        "Consider the following example:\n"
        "\\code\n"
        "/*! Invisible class because of truncation */\n"
        "class Invisible { };\n\n"
        "/*! Truncated class, inheritance relation is hidden */\n"
        "class Truncated : public Invisible { };\n\n"
        "/* Class not documented with doxygen comments */\n"
        "class Undocumented { };\n\n"
        "/*! Class that is inherited using public inheritance */\n"
        "class PublicBase : public Truncated { };\n\n"
        "/*! A template class */\n"
        "template<class T> class Templ { };\n\n"
        "/*! Class that is inherited using protected inheritance */\n"
        "class ProtectedBase { };\n\n"
        "/*! Class that is inherited using private inheritance */\n"
        "class PrivateBase { };\n\n"
        "/*! Class that is used by the Inherited class */\n"
        "class Used { };\n\n"
        "/*! Super class that inherits a number of other classes */\n"
        "class Inherited : public PublicBase,\n"
        "                  protected ProtectedBase,\n"
        "                  private PrivateBase,\n"
        "                  public Undocumented,\n"
        "                  public Templ<int>\n"
        "{\n"
        "  private:\n"
        "    Used *m_usedClass;\n"
        "};\n"
        "\\endcode\n"
        "This will result in the following graph:"
        "<p><center><img alt=\"\" src=\"graph_legend."+getDotImageExtension()+"\"></center></p>\n"
        "<p>\n"
        "The boxes in the above graph have the following meaning:\n"
        "</p>\n"
        "<ul>\n"
        "<li>%A filled gray box represents the struct or class for which the "
        "graph is generated.</li>\n"
        "<li>%A box with a black border denotes a documented struct or class.</li>\n"
        "<li>%A box with a gray border denotes an undocumented struct or class.</li>\n"
        "<li>%A box with a red border denotes a documented struct or class for"
        "which not all inheritance/containment relations are shown. %A graph is "
        "truncated if it does not fit within the specified boundaries.</li>\n"
        "</ul>\n"
        "<p>\n"
        "The arrows have the following meaning:\n"
        "</p>\n"
        "<ul>\n"
        "<li>%A blue arrow is used to visualize a public inheritance "
        "relation between two classes.</li>\n"
        "<li>%A dark green arrow is used for protected inheritance.</li>\n"
        "<li>%A dark red arrow is used for private inheritance.</li>\n"
        "<li>%A purple dashed arrow is used if a class is contained or used "
        "by another class. The arrow is labeled with the variable(s) "
        "through which the pointed class or struct is accessible.</li>\n"
        "<li>%A yellow dashed arrow denotes a relation between a template instance and "
        "the template class it was instantiated from. The arrow is labeled with "
        "the template parameters of the instance.</li>\n"
        "</ul>\n";
    }

References getDotImageExtension().

◆ trLegendTitle()

QCString TranslatorEnglish::trLegendTitle ( )

inlineoverridevirtual

title of the graph legend page

Implements Translator.

Definition at line 997 of file translator_en.h.

    {
      return "Graph Legend";
    }

◆ trListOfAllMembers()

QCString TranslatorEnglish::trListOfAllMembers ( )

inlineoverridevirtual

put in the class documentation

Implements Translator.

Definition at line 143 of file translator_en.h.

144 { return "List of all members"; }

◆ trLoading()

QCString TranslatorEnglish::trLoading ( )

inlineoverridevirtual

Loading message shown when loading search results

Implements Translator.

Definition at line 1739 of file translator_en.h.

    {
      return "Loading...";
    }

◆ trMainPage()

QCString TranslatorEnglish::trMainPage ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 797 of file translator_en.h.

798 { return "Main Page"; }

◆ trMember()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1254 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "member", "s");
    }

References Translator::createNoun().

◆ trMemberDataDocumentation()

QCString TranslatorEnglish::trMemberDataDocumentation ( )

inlineoverridevirtual

header that is put before the list of member attributes.

Implements Translator.

Definition at line 126 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Field Documentation";
      }
      else
      {
        return "Member Data Documentation";
      }
    }

References Config_getBool.

◆ trMemberEnumerationDocumentation()

QCString TranslatorEnglish::trMemberEnumerationDocumentation ( )

inlineoverridevirtual

header that is put before the list of enumerations.

Implements Translator.

Definition at line 109 of file translator_en.h.

110 { return "Member Enumeration Documentation"; }

◆ trMemberFunctionDocumentation()

QCString TranslatorEnglish::trMemberFunctionDocumentation ( )

inlineoverridevirtual

header that is put before the list of member functions.

Implements Translator.

Definition at line 113 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
      {
        return "Member Function/Procedure/Process Documentation";
      }
      else
      {
        return "Member Function Documentation";
      }
    }

References Config_getBool.

◆ trMemberFunctionDocumentationFortran()

QCString TranslatorEnglish::trMemberFunctionDocumentationFortran ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1536 of file translator_en.h.

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

◆ trMemberList()

QCString TranslatorEnglish::trMemberList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 147 of file translator_en.h.

148 { return "Member List"; }

◆ trMemberTypedefDocumentation()

QCString TranslatorEnglish::trMemberTypedefDocumentation ( )

inlineoverridevirtual

header that is put before the list of typedefs.

Implements Translator.

Definition at line 105 of file translator_en.h.

106 { return "Member Typedef Documentation"; }

◆ trMethodDocumentation()

QCString TranslatorEnglish::trMethodDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1936 of file translator_en.h.

    {
      return "Method Documentation";
    }

◆ trModule()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1675 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "module", "s");
    }

References Translator::createNoun().

◆ trModuleDocumentation()

QCString TranslatorEnglish::trModuleDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 407 of file translator_en.h.

408 { return "Module Documentation"; }

◆ trModuleIndex()

QCString TranslatorEnglish::trModuleIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 374 of file translator_en.h.

375 { return "Module Index"; }

◆ trModuleMembersDescriptionTotal()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2556 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="module ";
      QCString singularResult = "";
      QCString pluralResult = "";
      switch (hl)
      {
        case ModuleMemberHighlight::All:
          singularResult="member";
          break;
        case ModuleMemberHighlight::Functions:
          singularResult="function";
          break;
        case ModuleMemberHighlight::Variables:
          singularResult="variable";
          break;
        case ModuleMemberHighlight::Typedefs:
          singularResult="typedef";
          break;
        case ModuleMemberHighlight::Enums:
          singularResult="enum";
          break;
        case ModuleMemberHighlight::EnumValues:
          singularResult="enum value";
          break;
        case ModuleMemberHighlight::Total: // for completeness
          break;
      }
      result+=(pluralResult.isEmpty() ? singularResult+"s" : pluralResult);
      result+=" with links to ";
      if (extractAll)
        result+="the module documentation for each " + singularResult + ":";
      else
        result+="the module they belong to:";
      return result;
    }

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 )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1637 of file translator_en.h.

    {
      QCString result=namespaceName;
      result+=" Module Reference";
      return result;
    }

◆ trModules()

QCString TranslatorEnglish::trModules ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 185 of file translator_en.h.

186 { return "Modules"; }

◆ trModulesDescription()

QCString TranslatorEnglish::trModulesDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 362 of file translator_en.h.

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

◆ trModulesIndex()

QCString TranslatorEnglish::trModulesIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1668 of file translator_en.h.

1669 { return "Modules Index"; }

◆ trModulesList()

QCString TranslatorEnglish::trModulesList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1603 of file translator_en.h.

1604 { return "Modules List"; }

◆ trModulesListDescription()

QCString TranslatorEnglish::trModulesListDescription ( bool extractAll )

inlineoverridevirtual

used as an introduction to the modules list (Fortran)

Implements Translator.

Definition at line 1607 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="modules with brief descriptions:";
      return result;
    }

◆ trModulesMemberDescription()

QCString TranslatorEnglish::trModulesMemberDescription ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1649 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="module members with links to ";
      if (extractAll)
      {
        result+="the module documentation for each member:";
      }
      else
      {
        result+="the modules they belong to:";
      }
      return result;
    }

◆ trModulesMembers()

QCString TranslatorEnglish::trModulesMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1645 of file translator_en.h.

1646 { return "Module Members"; }

◆ trMonth()

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

inlineoverridevirtual

Implements Translator.

Definition at line 1820 of file translator_en.h.

    {
      static const char *months_short[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
      static const char *months_full[]  = { "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" };
      return full? months_full[month-1] : months_short[month-1];
    }

◆ trMore()

QCString TranslatorEnglish::trMore ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 139 of file translator_en.h.

140 { return "More..."; }

◆ trNamespace()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1227 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "namespace", "s");
    }

References Translator::createNoun().

◆ trNamespaceDocumentation()

QCString TranslatorEnglish::trNamespaceDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 746 of file translator_en.h.

747 { return "Namespace Documentation"; }

◆ trNamespaceIndex()

QCString TranslatorEnglish::trNamespaceIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 740 of file translator_en.h.

741 { return "Namespace Index"; }

◆ trNamespaceList()

QCString TranslatorEnglish::trNamespaceList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 574 of file translator_en.h.

575 { return "Namespace List"; }

◆ trNamespaceListDescription()

QCString TranslatorEnglish::trNamespaceListDescription ( bool extractAll )

inlineoverridevirtual

used as an introduction to the namespace list

Implements Translator.

Definition at line 578 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="namespaces with brief descriptions:";
      return result;
    }

◆ trNamespaceMemberDescription()

QCString TranslatorEnglish::trNamespaceMemberDescription ( bool extractAll )

inlineoverridevirtual

This is an introduction to the page with all namespace members

Implements Translator.

Definition at line 726 of file translator_en.h.

    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="namespace members with links to ";
      if (extractAll)
        result+="the namespace documentation for each member:";
      else
        result+="the namespaces they belong to:";
      return result;
    }

◆ trNamespaceMembers()

QCString TranslatorEnglish::trNamespaceMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 722 of file translator_en.h.

723 { return "Namespace Members"; }

◆ trNamespaceMembersDescriptionTotal()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2493 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="namespace ";
      QCString singularResult = "";
      QCString pluralResult = "";
      switch (hl)
      {
        case NamespaceMemberHighlight::All:
          singularResult="member";
          break;
        case NamespaceMemberHighlight::Functions:
          singularResult="function";
          break;
        case NamespaceMemberHighlight::Variables:
          singularResult="variable";
          break;
        case NamespaceMemberHighlight::Typedefs:
          singularResult="typedef";
          break;
        case NamespaceMemberHighlight::Sequences:
          singularResult="sequence";
          break;
        case NamespaceMemberHighlight::Dictionaries:
          singularResult="dictionary";
          pluralResult="dictionaries";
          break;
        case NamespaceMemberHighlight::Enums:
          singularResult="enum";
          break;
        case NamespaceMemberHighlight::EnumValues:
          singularResult="enum value";
          break;
        case NamespaceMemberHighlight::Total: // for completeness
          break;
      }
      result+=(pluralResult.isEmpty() ? singularResult+"s" : pluralResult);
      result+=" with links to ";
      if (extractAll)
        result+="the namespace documentation for each " + singularResult + ":";
      else
        result+="the namespaces they belong to:";
      return result;
    }

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 )

inlineoverridevirtual

used as the title of the HTML page of a namespace

Implements Translator.

Definition at line 637 of file translator_en.h.

    {
      QCString result=namespaceName;
      result+=" Namespace Reference";
      return result;
    }

◆ trNamespaces()

QCString TranslatorEnglish::trNamespaces ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 756 of file translator_en.h.

757 { return "Namespaces"; }

◆ trNoMatches()

QCString TranslatorEnglish::trNoMatches ( )

inlineoverridevirtual

Text shown when no search results are found

Implements Translator.

Definition at line 1757 of file translator_en.h.

    {
      return "No Matches";
    }

◆ trNote()

QCString TranslatorEnglish::trNote ( )

inlineoverridevirtual

Implements Translator.

Definition at line 903 of file translator_en.h.

    {
      return "Note";
    }

◆ trOperationDocumentation()

QCString TranslatorEnglish::trOperationDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2233 of file translator_en.h.

    {
        return "Operation Documentation";
    }

◆ trOperations()

QCString TranslatorEnglish::trOperations ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2229 of file translator_en.h.

    {
        return "Operations";
    }

◆ trOverloadText()

QCString TranslatorEnglish::trOverloadText ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1508 of file translator_en.h.

    {
       return "This is an overloaded member function, "
              "provided for convenience. It differs from the above "
              "function only in what argument(s) it accepts.";
    }

◆ trPackage()

QCString TranslatorEnglish::trPackage ( const QCString & name )

inlineoverridevirtual

Used as the title of a Java package

Implements Translator.

Definition at line 1121 of file translator_en.h.

    {
      return "Package "+name;
    }

◆ trPackageAttribs()

QCString TranslatorEnglish::trPackageAttribs ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1382 of file translator_en.h.

    {
      return "Package Attributes";
    }

◆ trPackageFunctions()

QCString TranslatorEnglish::trPackageFunctions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1364 of file translator_en.h.

    {
      return "Package Functions";
    }

◆ trPackageList()

QCString TranslatorEnglish::trPackageList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2302 of file translator_en.h.

2303 { return "Package List"; }

◆ trPackageListDescription()

QCString TranslatorEnglish::trPackageListDescription ( )

inlineoverridevirtual

The description of the package index page

Implements Translator.

Definition at line 1126 of file translator_en.h.

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

◆ trPackageMembers()

QCString TranslatorEnglish::trPackageMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 1368 of file translator_en.h.

    {
      return "Package Members";
    }

◆ trPackages()

QCString TranslatorEnglish::trPackages ( )

inlineoverridevirtual

The link name in the Quick links header for each page

Implements Translator.

Definition at line 1131 of file translator_en.h.

    {
      return "Packages";
    }

◆ trPackageTypes()

QCString TranslatorEnglish::trPackageTypes ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1357 of file translator_en.h.

    {
      return "Package Types";
    }

◆ trPage()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1245 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "page", "s");
    }

References Translator::createNoun().

◆ trPageAbbreviation()

QCString TranslatorEnglish::trPageAbbreviation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 803 of file translator_en.h.

804 { return "p."; }

◆ trPageIndex()

QCString TranslatorEnglish::trPageIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 894 of file translator_en.h.

    {
      return "Page Index";
    }

◆ trPanelSynchronisationTooltip()

QCString TranslatorEnglish::trPanelSynchronisationTooltip ( bool enable )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1894 of file translator_en.h.

    {
      QCString opt = enable ? "enable" : "disable";
      return "click to "+opt+" panel synchronization";
    }

◆ trParameters()

QCString TranslatorEnglish::trParameters ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 558 of file translator_en.h.

559 { return "Parameters"; }

◆ trPostcondition()

QCString TranslatorEnglish::trPostcondition ( )

inlineoverridevirtual

Text for the \post command

Implements Translator.

Definition at line 863 of file translator_en.h.

    {
      return "Postcondition";
    }

◆ trPrecondition()

QCString TranslatorEnglish::trPrecondition ( )

inlineoverridevirtual

Text for the \pre command

Implements Translator.

Definition at line 858 of file translator_en.h.

    {
      return "Precondition";
    }

◆ trPrivateAttribs()

QCString TranslatorEnglish::trPrivateAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 942 of file translator_en.h.

    {
      return "Private Attributes";
    }

◆ trPrivateMembers()

QCString TranslatorEnglish::trPrivateMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 658 of file translator_en.h.

659 { return "Private Member Functions"; }

◆ trPrivateSlots()

QCString TranslatorEnglish::trPrivateSlots ( )

inlineoverridevirtual

Implements Translator.

Definition at line 660 of file translator_en.h.

661 { return "Private Slots"; }

◆ trPrivateTypes()

QCString TranslatorEnglish::trPrivateTypes ( )

inlineoverridevirtual

Implements Translator.

Definition at line 938 of file translator_en.h.

    {
      return "Private Types";
    }

◆ trProperties()

QCString TranslatorEnglish::trProperties ( )

inlineoverridevirtual

Used as a section header for IDL properties

Implements Translator.

Definition at line 1094 of file translator_en.h.

    {
      return "Properties";
    }

◆ trPropertyDocumentation()

QCString TranslatorEnglish::trPropertyDocumentation ( )

inlineoverridevirtual

Used as a section header for IDL property documentation

Implements Translator.

Definition at line 1099 of file translator_en.h.

    {
      return "Property Documentation";
    }

◆ trProtectedAttribs()

QCString TranslatorEnglish::trProtectedAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 930 of file translator_en.h.

    {
      return "Protected Attributes";
    }

◆ trProtectedMembers()

QCString TranslatorEnglish::trProtectedMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 652 of file translator_en.h.

653 { return "Protected Member Functions"; }

◆ trProtectedSlots()

QCString TranslatorEnglish::trProtectedSlots ( )

inlineoverridevirtual

Implements Translator.

Definition at line 654 of file translator_en.h.

655 { return "Protected Slots"; }

◆ trProtectedTypes()

QCString TranslatorEnglish::trProtectedTypes ( )

inlineoverridevirtual

Implements Translator.

Definition at line 926 of file translator_en.h.

    {
      return "Protected Types";
    }

◆ trProvidedByCategory()

QCString TranslatorEnglish::trProvidedByCategory ( )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1904 of file translator_en.h.

    {
      return "Provided by category @0.";
    }

◆ trPublicAttribs()

QCString TranslatorEnglish::trPublicAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 911 of file translator_en.h.

    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Fields";
      }
      else
      {
        return "Public Attributes";
      }
    }

References Config_getBool.

◆ trPublicMembers()

QCString TranslatorEnglish::trPublicMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 644 of file translator_en.h.

645 { return "Public Member Functions"; }

◆ trPublicSlots()

QCString TranslatorEnglish::trPublicSlots ( )

inlineoverridevirtual

Implements Translator.

Definition at line 646 of file translator_en.h.

647 { return "Public Slots"; }

◆ trPublicTypes()

QCString TranslatorEnglish::trPublicTypes ( )

inlineoverridevirtual

Implements Translator.

Definition at line 907 of file translator_en.h.

    {
      return "Public Types";
    }

◆ trReferencedBy()

QCString TranslatorEnglish::trReferencedBy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 970 of file translator_en.h.

    {
      return "Referenced by";
    }

◆ trReferenceManual()

QCString TranslatorEnglish::trReferenceManual ( )

inlineoverridevirtual

This is used in LaTeX as the title of the document

Implements Translator.

Definition at line 436 of file translator_en.h.

437 { return "Reference Manual"; }

◆ trReferences()

QCString TranslatorEnglish::trReferences ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1285 of file translator_en.h.

    {
      return "References";
    }

◆ trReimplementedFromList()

QCString TranslatorEnglish::trReimplementedFromList ( int numEntries )

inlineoverridevirtual

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

Implements Translator.

Definition at line 708 of file translator_en.h.

    {
      return "Reimplemented from "+trWriteList(numEntries)+".";
    }

References trWriteList().

◆ trReimplementedInList()

QCString TranslatorEnglish::trReimplementedInList ( int numEntries )

inlineoverridevirtual

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

Implements Translator.

Definition at line 716 of file translator_en.h.

    {
      return "Reimplemented in "+trWriteList(numEntries)+".";
    }

References trWriteList().

◆ trRelatedFunctionDocumentation()

QCString TranslatorEnglish::trRelatedFunctionDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 599 of file translator_en.h.

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

◆ trRelatedFunctions()

QCString TranslatorEnglish::trRelatedFunctions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 89 of file translator_en.h.

90 { return "Related Functions"; }

◆ trRelatedPages()

QCString TranslatorEnglish::trRelatedPages ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 236 of file translator_en.h.

237 { return "Related Pages"; }

◆ trRelatedPagesDescription()

QCString TranslatorEnglish::trRelatedPagesDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 358 of file translator_en.h.

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

◆ trRelatedSubscript()

QCString TranslatorEnglish::trRelatedSubscript ( )

inlineoverridevirtual

subscript for the related functions.

Implements Translator.

Definition at line 93 of file translator_en.h.

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

◆ trRelatedSymbolDocumentation()

QCString TranslatorEnglish::trRelatedSymbolDocumentation ( )

inlineoverridevirtual

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

Supersedes trRelatedFunctionDocumentation

Implements Translator.

Definition at line 2342 of file translator_en.h.

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

◆ trRelatedSymbols()

QCString TranslatorEnglish::trRelatedSymbols ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2327 of file translator_en.h.

2328 { return "Related Symbols"; }

◆ trRelatedSymbolsSubscript()

QCString TranslatorEnglish::trRelatedSymbolsSubscript ( )

inlineoverridevirtual

subscript for the related symbols

Supersedes trRelatedSubscript

Implements Translator.

Definition at line 2334 of file translator_en.h.

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

◆ trRemarks()

QCString TranslatorEnglish::trRemarks ( )

inlineoverridevirtual

Implements Translator.

Definition at line 974 of file translator_en.h.

    {
      return "Remarks";
    }

◆ trReturns()

QCString TranslatorEnglish::trReturns ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 550 of file translator_en.h.

551 { return "Returns"; }

◆ trReturnValues()

QCString TranslatorEnglish::trReturnValues ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 792 of file translator_en.h.

793 { return "Return values"; }

◆ trRTFansicp()

QCString TranslatorEnglish::trRTFansicp ( )

inlineoverridevirtual

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

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 1185 of file translator_en.h.

    {
      return "1252";
    }

◆ trRTFCharSet()

QCString TranslatorEnglish::trRTFCharSet ( )

inlineoverridevirtual

Used as ansicpg for RTF fcharset

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

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 1194 of file translator_en.h.

    {
      return "0";
    }

◆ trRTFGeneralIndex()

QCString TranslatorEnglish::trRTFGeneralIndex ( )

inlineoverridevirtual

Used as header RTF general index

Implements Translator.

Definition at line 1200 of file translator_en.h.

    {
      return "Index";
    }

◆ trRTFTableOfContents()

QCString TranslatorEnglish::trRTFTableOfContents ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1317 of file translator_en.h.

    {
      return "Table of Contents";
    }

◆ trSearch()

QCString TranslatorEnglish::trSearch ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 244 of file translator_en.h.

245 { return "Search"; }

◆ trSearching()

QCString TranslatorEnglish::trSearching ( )

inlineoverridevirtual

Message shown while searching

Implements Translator.

Definition at line 1751 of file translator_en.h.

    {
      return "Searching...";
    }

◆ trSearchMatches()

QCString TranslatorEnglish::trSearchMatches ( )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1449 of file translator_en.h.

    {
      return "Matches:";
    }

◆ trSearchResults()

QCString TranslatorEnglish::trSearchResults ( int numDocuments )

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1430 of file translator_en.h.

    {
      if (numDocuments==0)
      {
        return "Sorry, no documents matching your query.";
      }
      else if (numDocuments==1)
      {
        return "Found <b>1</b> document matching your query.";
      }
      else
      {
        return "Found <b>$num</b> documents matching your query. "
               "Showing best matches first.";
      }
    }

◆ trSearchResultsTitle()

QCString TranslatorEnglish::trSearchResultsTitle ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1418 of file translator_en.h.

    {
      return "Search Results";
    }

◆ trSeeAlso()

QCString TranslatorEnglish::trSeeAlso ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 554 of file translator_en.h.

555 { return "See also"; }

◆ trSequenceDocumentation()

QCString TranslatorEnglish::trSequenceDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2127 of file translator_en.h.

    {
        return "Sequence Documentation";
    }

◆ trSequences()

QCString TranslatorEnglish::trSequences ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2123 of file translator_en.h.

    {
        return "Sequences";
    }

◆ trServiceGeneratedFromFiles()

QCString TranslatorEnglish::trServiceGeneratedFromFiles ( bool single )

inlineoverridevirtual

UNO IDL service page.

Implements Translator.

Definition at line 1979 of file translator_en.h.

    {
      // single is true implies a single file
      QCString result="The documentation for this service "
                      "was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }

◆ trServiceReference()

QCString TranslatorEnglish::trServiceReference ( const QCString & sName )

inlineoverridevirtual

UNO IDL service page title.

Implements Translator.

Definition at line 1965 of file translator_en.h.

    {
      QCString result=sName;
      result+=" Service Reference";
      return result;
    }

◆ trServices()

QCString TranslatorEnglish::trServices ( )

inlineoverridevirtual

old style UNO IDL services: inherited services

Implements Translator.

Definition at line 1950 of file translator_en.h.

1951 { return "Included Services"; }

◆ trSignals()

QCString TranslatorEnglish::trSignals ( )

inlineoverridevirtual

Implements Translator.

Definition at line 648 of file translator_en.h.

649 { return "Signals"; }

◆ trSince()

QCString TranslatorEnglish::trSince ( )

inlineoverridevirtual

Implements Translator.

Definition at line 987 of file translator_en.h.

    {
      return "Since";
    }

◆ trSingletonGeneratedFromFiles()

QCString TranslatorEnglish::trSingletonGeneratedFromFiles ( bool single )

inlineoverridevirtual

UNO IDL singleton page.

Implements Translator.

Definition at line 1988 of file translator_en.h.

    {
      // single is true implies a single file
      QCString result="The documentation for this singleton "
                      "was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }

◆ trSingletonReference()

QCString TranslatorEnglish::trSingletonReference ( const QCString & sName )

inlineoverridevirtual

UNO IDL singleton page title.

Implements Translator.

Definition at line 1972 of file translator_en.h.

    {
      QCString result=sName;
      result+=" Singleton Reference";
      return result;
    }

◆ trSliceInterfaces()

QCString TranslatorEnglish::trSliceInterfaces ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2139 of file translator_en.h.

    {
        return "Interfaces";
    }

◆ trSourceFile()

QCString TranslatorEnglish::trSourceFile ( const QCString & filename )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1460 of file translator_en.h.

    {
      return filename + " Source File";
    }

◆ trStaticPackageAttribs()

QCString TranslatorEnglish::trStaticPackageAttribs ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1389 of file translator_en.h.

    {
      return "Static Package Attributes";
    }

◆ trStaticPackageFunctions()

QCString TranslatorEnglish::trStaticPackageFunctions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1375 of file translator_en.h.

    {
      return "Static Package Functions";
    }

◆ trStaticPrivateAttribs()

QCString TranslatorEnglish::trStaticPrivateAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 946 of file translator_en.h.

    {
      return "Static Private Attributes";
    }

◆ trStaticPrivateMembers()

QCString TranslatorEnglish::trStaticPrivateMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 662 of file translator_en.h.

663 { return "Static Private Member Functions"; }

◆ trStaticProtectedAttribs()

QCString TranslatorEnglish::trStaticProtectedAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 934 of file translator_en.h.

    {
      return "Static Protected Attributes";
    }

◆ trStaticProtectedMembers()

QCString TranslatorEnglish::trStaticProtectedMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 656 of file translator_en.h.

657 { return "Static Protected Member Functions"; }

◆ trStaticPublicAttribs()

QCString TranslatorEnglish::trStaticPublicAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 922 of file translator_en.h.

    {
      return "Static Public Attributes";
    }

◆ trStaticPublicMembers()

QCString TranslatorEnglish::trStaticPublicMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 650 of file translator_en.h.

651 { return "Static Public Member Functions"; }

◆ trStructDocumentation()

QCString TranslatorEnglish::trStructDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2183 of file translator_en.h.

    {
        return "Struct Documentation";
    }

◆ trStructIndex()

QCString TranslatorEnglish::trStructIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2171 of file translator_en.h.

    {
        return "Struct Index";
    }

◆ trStructList()

QCString TranslatorEnglish::trStructList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2175 of file translator_en.h.

    {
        return "Struct List";
    }

◆ trStructListDescription()

QCString TranslatorEnglish::trStructListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2179 of file translator_en.h.

    {
        return "Here are the structs with brief descriptions:";
    }

◆ trStructs()

QCString TranslatorEnglish::trStructs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2167 of file translator_en.h.

    {
        return "Structs";
    }

◆ trSubprogram()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1717 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "subprogram", "s");
    }

References Translator::createNoun().

◆ trSubprogramDocumentation()

QCString TranslatorEnglish::trSubprogramDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1593 of file translator_en.h.

1594 { return "Function/Subroutine Documentation"; }

◆ trSubprograms()

QCString TranslatorEnglish::trSubprograms ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1587 of file translator_en.h.

1588 { return "Functions/Subroutines"; }

◆ trTemplateParameters()

QCString TranslatorEnglish::trTemplateParameters ( )

inlineoverridevirtual

Section header for list of template parameters

Implements Translator.

Definition at line 1857 of file translator_en.h.

1858 { return "Template Parameters"; }

◆ trTest()

QCString TranslatorEnglish::trTest ( )

inlineoverridevirtual

Used as a marker that is put before a test item

Implements Translator.

Definition at line 1079 of file translator_en.h.

    {
      return "Test";
    }

◆ trTestList()

QCString TranslatorEnglish::trTestList ( )

inlineoverridevirtual

Used as the header of the test list

Implements Translator.

Definition at line 1084 of file translator_en.h.

    {
      return "Test List";
    }

◆ trThisIsTheListOfAllMembers()

QCString TranslatorEnglish::trThisIsTheListOfAllMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 151 of file translator_en.h.

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

◆ trTodo()

QCString TranslatorEnglish::trTodo ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 956 of file translator_en.h.

    {
      return "Todo";
    }

◆ trTodoList()

QCString TranslatorEnglish::trTodoList ( )

inlineoverridevirtual

Used as the header of the todo list

Implements Translator.

Definition at line 961 of file translator_en.h.

    {
      return "Todo List";
    }

◆ trTopicDocumentation()

QCString TranslatorEnglish::trTopicDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2548 of file translator_en.h.

2549 { return "Topic Documentation"; }

◆ trTopicIndex()

QCString TranslatorEnglish::trTopicIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2552 of file translator_en.h.

2553 { return "Topic Index"; }

◆ trTopicList()

QCString TranslatorEnglish::trTopicList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2550 of file translator_en.h.

2551 { return "Topic List"; }

◆ trTopicListDescription()

QCString TranslatorEnglish::trTopicListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2554 of file translator_en.h.

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

◆ trTopics()

QCString TranslatorEnglish::trTopics ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2546 of file translator_en.h.

2547 { return "Topics"; }

◆ trType()

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

inlineoverridevirtual

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.

Implements Translator.

Definition at line 1708 of file translator_en.h.

    {
      return createNoun(first_capital, singular, "type", "s");
    }

References Translator::createNoun().

Referenced by trCompoundType().

◆ trTypeConstraints()

QCString TranslatorEnglish::trTypeConstraints ( )

inlineoverridevirtual

C# Type Constraint list

Implements Translator.

Definition at line 1723 of file translator_en.h.

    {
      return "Type Constraints";
    }

◆ trTypedefDocumentation()

QCString TranslatorEnglish::trTypedefDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 484 of file translator_en.h.

485 { return "Typedef Documentation"; }

◆ trTypedefs()

QCString TranslatorEnglish::trTypedefs ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 448 of file translator_en.h.

449 { return "Typedefs"; }

◆ trTypeDocumentation()

QCString TranslatorEnglish::trTypeDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1581 of file translator_en.h.

1582 { return "Data Type Documentation"; }

◆ trVariableDocumentation()

QCString TranslatorEnglish::trVariableDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 502 of file translator_en.h.

503 { return "Variable Documentation"; }

◆ trVariables()

QCString TranslatorEnglish::trVariables ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 466 of file translator_en.h.

467 { return "Variables"; }

◆ trVersion()

QCString TranslatorEnglish::trVersion ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 542 of file translator_en.h.

543 { return "Version"; }

◆ trVhdlType()

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

inlineoverridevirtual

VHDL type.

Implements Translator.

Definition at line 2026 of file translator_en.h.

    {
      switch(type)
      {
        case VhdlSpecifier::LIBRARY:
          if (single) return "Library";
          else        return "Libraries";
        case VhdlSpecifier::PACKAGE:
          if (single) return "Package";
          else        return "Packages";
        case VhdlSpecifier::SIGNAL:
          if (single) return "Signal";
          else        return "Signals";
        case VhdlSpecifier::COMPONENT:
          if (single) return "Component";
          else        return "Components";
        case VhdlSpecifier::CONSTANT:
          if (single) return "Constant";
          else        return "Constants";
        case VhdlSpecifier::ENTITY:
          if (single) return "Entity";
          else        return "Entities";
        case VhdlSpecifier::TYPE:
          if (single) return "Type";
          else        return "Types";
        case VhdlSpecifier::SUBTYPE:
          if (single) return "Subtype";
          else        return "Subtypes";
        case VhdlSpecifier::FUNCTION:
          if (single) return "Function";
          else        return "Functions";
        case VhdlSpecifier::RECORD:
          if (single) return "Record";
          else        return "Records";
        case VhdlSpecifier::PROCEDURE:
          if (single) return "Procedure";
          else        return "Procedures";
        case VhdlSpecifier::ARCHITECTURE:
          if (single) return "Architecture";
          else        return "Architectures";
        case VhdlSpecifier::ATTRIBUTE:
          if (single) return "Attribute";
          else        return "Attributes";
        case VhdlSpecifier::PROCESS:
          if (single) return "Process";
          else        return "Processes";
        case VhdlSpecifier::PORT:
          if (single) return "Port";
          else        return "Ports";
        case VhdlSpecifier::USE:
          if (single) return "use clause";
          else        return "Use Clauses";
        case VhdlSpecifier::GENERIC:
          if (single) return "Generic";
          else        return "Generics";
        case VhdlSpecifier::PACKAGE_BODY:
          return "Package Body";
        case VhdlSpecifier::UNITS:
          return "Units";
        case VhdlSpecifier::SHAREDVARIABLE:
          if (single) return "Shared Variable";
          else        return "Shared Variables";
        case VhdlSpecifier::VFILE:
          if (single) return "File";
          else        return "Files";
        case VhdlSpecifier::GROUP:
          if (single) return "Group";
          else        return "Groups";
        case VhdlSpecifier::INSTANTIATION:
          if (single) return "Instantiation";
          else        return "Instantiations";
        case VhdlSpecifier::ALIAS:
          if (single) return "Alias";
          else        return "Aliases";
        case VhdlSpecifier::CONFIG:
          if (single) return "Configuration";
          else        return "Configurations";
        case VhdlSpecifier::MISCELLANEOUS:
          return "Miscellaneous";
        case VhdlSpecifier::UCF_CONST:
          return "Constraints";
        default:
          return "Class";
      }
    }

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

inlineoverridevirtual

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

Implements Translator.

Definition at line 538 of file translator_en.h.

539 { return "Warning"; }

◆ trWriteList()

QCString TranslatorEnglish::trWriteList ( int numEntries )

inlineoverridevirtual

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

Implements Translator.

Definition at line 668 of file translator_en.h.

    {
      QCString result;
      // the inherits list contain `numEntries' classes
      for (int i=0;i<numEntries;i++)
      {
        // use generateMarker to generate placeholders for the class links!
        result+=generateMarker(i); // generate marker for entry i in the list
                                   // (order is left to right)
 
        if (i!=numEntries-1)  // not the last entry, so we need a separator
        {
          if (i<numEntries-2) // not the fore last entry
            result+=", ";
          else                // the fore last entry
            result+=", and ";
        }
      }
      return result;
    }

References generateMarker().

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

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

src/translator_en.h