#include <src/translator_en.h>

Inheritance diagram for TranslatorEnglish:

Collaboration diagram for TranslatorEnglish:

Public Member Functions
DString	idLanguage () override
DString	latexLanguageSupportCommand () override
DString	trISOLang () override
DString	getLanguageString () override
	language codes for Html help
DString	trRelatedFunctions () override
DString	trRelatedSubscript () override
DString	trDetailedDescription () override
DString	trDetails () override
DString	trMemberTypedefDocumentation () override
DString	trMemberEnumerationDocumentation () override
DString	trMemberFunctionDocumentation () override
DString	trMemberDataDocumentation () override
DString	trMore () override
DString	trListOfAllMembers () override
DString	trMemberList () override
DString	trThisIsTheListOfAllMembers () override
DString	trIncludingInheritedMembers () override
DString	trGeneratedAutomatically (const DString &s) override
DString	trEnumName () override
DString	trEnumValue () override
DString	trDefinedIn () override
DString	trModules () override
DString	trClassHierarchy () override
DString	trCompoundList () override
DString	trFileList () override
DString	trCompoundMembers () override
DString	trFileMembers () override
DString	trRelatedPages () override
DString	trExamples () override
DString	trSearch () override
DString	trClassHierarchyDescription () override
DString	trFileListDescription (bool extractAll) override
DString	trCompoundListDescription () override
DString	trCompoundMembersDescription (bool extractAll) override
DString	trFileMembersDescription (bool extractAll) override
DString	trExamplesDescription () override
DString	trRelatedPagesDescription () override
DString	trModulesDescription () override
DString	trDocumentation (const DString &projName) override
DString	trModuleIndex () override
DString	trHierarchicalIndex () override
DString	trCompoundIndex () override
DString	trFileIndex () override
DString	trModuleDocumentation () override
DString	trClassDocumentation () override
DString	trFileDocumentation () override
DString	trReferenceManual () override
DString	trDefines () override
DString	trTypedefs () override
DString	trEnumerations () override
DString	trFunctions () override
DString	trVariables () override
DString	trEnumerationValues () override
DString	trDefineDocumentation () override
DString	trTypedefDocumentation () override
DString	trEnumerationTypeDocumentation () override
DString	trFunctionDocumentation () override
DString	trVariableDocumentation () override
DString	trCompounds () override
DString	trGeneratedAt (const DString &date, const DString &projName) override
DString	trClassDiagram (const DString &clName) override
DString	trWarning () override
DString	trVersion () override
DString	trDate () override
DString	trReturns () override
DString	trSeeAlso () override
DString	trParameters () override
DString	trExceptions () override
DString	trGeneratedBy () override
DString	trNamespaceList () override
DString	trNamespaceListDescription (bool extractAll) override
DString	trFriends () override
DString	trRelatedFunctionDocumentation () override
DString	trCompoundReference (const DString &clName, ClassDef::CompoundType compType, bool isTemplate) override
DString	trFileReference (const DString &fileName) override
DString	trNamespaceReference (const DString &namespaceName) override
DString	trPublicMembers () override
DString	trPublicSlots () override
DString	trSignals () override
DString	trStaticPublicMembers () override
DString	trProtectedMembers () override
DString	trProtectedSlots () override
DString	trStaticProtectedMembers () override
DString	trPrivateMembers () override
DString	trPrivateSlots () override
DString	trStaticPrivateMembers () override
DString	trWriteList (int numEntries) override
DString	trInheritsList (int numEntries) override
DString	trInheritedByList (int numEntries) override
DString	trReimplementedFromList (int numEntries) override
DString	trReimplementedInList (int numEntries) override
DString	trNamespaceMembers () override
DString	trNamespaceMemberDescription (bool extractAll) override
DString	trNamespaceIndex () override
DString	trNamespaceDocumentation () override
DString	trNamespaces () override
DString	trGeneratedFromFiles (ClassDef::CompoundType compType, bool single) override
DString	trReturnValues () override
DString	trMainPage () override
DString	trPageAbbreviation () override
DString	trDefinedAtLineInSourceFile () override
DString	trDefinedInSourceFile () override
DString	trDeprecated () override
DString	trCollaborationDiagram (const DString &clName) override
DString	trInclDepGraph (const DString &fName) override
DString	trConstructorDocumentation () override
DString	trGotoSourceCode () override
DString	trGotoDocumentation () override
DString	trPrecondition () override
DString	trPostcondition () override
DString	trInvariant () override
DString	trInitialValue () override
DString	trCode () override
DString	trGraphicalHierarchy () override
DString	trGotoGraphicalHierarchy () override
DString	trGotoTextualHierarchy () override
DString	trPageIndex () override
DString	trNote () override
DString	trPublicTypes () override
DString	trPublicAttribs () override
DString	trStaticPublicAttribs () override
DString	trProtectedTypes () override
DString	trProtectedAttribs () override
DString	trStaticProtectedAttribs () override
DString	trPrivateTypes () override
DString	trPrivateAttribs () override
DString	trStaticPrivateAttribs () override
DString	trTodo () override
DString	trTodoList () override
DString	trReferencedBy () override
DString	trRemarks () override
DString	trAttention () override
DString	trInclByDepGraph () override
DString	trSince () override
DString	trLegendTitle () override
DString	trLegendDocs () override
DString	trLegend () override
DString	trTest () override
DString	trTestList () override
DString	trProperties () override
DString	trPropertyDocumentation () override
DString	trClasses () override
DString	trPackage (const DString &name) override
DString	trPackageListDescription () override
DString	trPackages () override
DString	trDefineValue () override
DString	trBug () override
DString	trBugList () override
DString	trRTFansicp () override
DString	trRTFCharSet () override
DString	trRTFGeneralIndex () override
DString	trClass (bool first_capital, bool singular) override
DString	trFile (bool first_capital, bool singular) override
DString	trNamespace (bool first_capital, bool singular) override
DString	trGroup (bool first_capital, bool singular) override
DString	trPage (bool first_capital, bool singular) override
DString	trMember (bool first_capital, bool singular) override
DString	trGlobal (bool first_capital, bool singular) override
DString	trAuthor (bool first_capital, bool singular) override
DString	trReferences () override
DString	trImplementedFromList (int numEntries) override
DString	trImplementedInList (int numEntries) override
DString	trRTFTableOfContents () override
DString	trDeprecatedList () override
DString	trEvents () override
DString	trEventDocumentation () override
DString	trPackageTypes () override
DString	trPackageFunctions () override
DString	trPackageMembers () override
DString	trStaticPackageFunctions () override
DString	trPackageAttribs () override
DString	trStaticPackageAttribs () override
DString	trAll () override
DString	trCallGraph () override
DString	trSearchResultsTitle () override
DString	trSearchResults (int numDocuments) override
DString	trSearchMatches () override
DString	trSourceFile (const DString &filename) override
DString	trDirIndex () override
DString	trDirDocumentation () override
DString	trDirectories () override
DString	trDirReference (const DString &dirName) override
DString	trDir (bool first_capital, bool singular) override
DString	trOverloadText () override
DString	trCallerGraph () override
DString	trEnumerationValueDocumentation () override
DString	trMemberFunctionDocumentationFortran () override
DString	trCompoundListFortran () override
DString	trCompoundMembersFortran () override
DString	trCompoundListDescriptionFortran () override
DString	trCompoundMembersDescriptionFortran (bool extractAll) override
DString	trCompoundIndexFortran () override
DString	trTypeDocumentation () override
DString	trSubprograms () override
DString	trSubprogramDocumentation () override
DString	trDataTypes () override
DString	trModulesList () override
DString	trModulesListDescription (bool extractAll) override
DString	trCompoundReferenceFortran (const DString &clName, ClassDef::CompoundType compType, bool isTemplate) override
DString	trModuleReference (const DString &namespaceName) override
DString	trModulesMembers () override
DString	trModulesMemberDescription (bool extractAll) override
DString	trModulesIndex () override
DString	trModule (bool first_capital, bool singular) override
DString	trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single) override
DString	trType (bool first_capital, bool singular) override
DString	trSubprogram (bool first_capital, bool singular) override
DString	trTypeConstraints () override
DString	trDirRelation (const DString &name) override
DString	trLoading () override
DString	trGlobalNamespace () override
DString	trSearching () override
DString	trNoMatches () override
DString	trFileIn (const DString &name) override
DString	trIncludesFileIn (const DString &name) override
DString	trDateTime (int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime) override
	Compiles a date string.
DString	trDayOfWeek (int dayOfWeek, bool, bool full) override
DString	trMonth (int month, bool, bool full) override
DString	trDayPeriod (bool period) override
DString	trCiteReferences () override
DString	trCopyright () override
DString	trDirDepGraph (const DString &name) override
DString	trDetailLevel () override
DString	trTemplateParameters () override
DString	trAndMore (const DString &number) override
DString	trEnumGeneratedFromFiles (bool single) override
DString	trEnumReference (const DString &name) override
DString	trInheritedFrom (const DString &members, const DString &what) override
DString	trAdditionalInheritedMembers () override
DString	trPanelSynchronisationTooltip (bool enable) override
DString	trProvidedByCategory () override
DString	trExtendsClass () override
DString	trClassMethods () override
DString	trInstanceMethods () override
DString	trMethodDocumentation () override
DString	trInterfaces () override
	old style UNO IDL services: implemented interfaces
DString	trServices () override
	old style UNO IDL services: inherited services
DString	trConstantGroups () override
	UNO IDL constant groups.
DString	trConstantGroupReference (const DString &namespaceName) override
	UNO IDL constant groups.
DString	trServiceReference (const DString &sName) override
	UNO IDL service page title.
DString	trSingletonReference (const DString &sName) override
	UNO IDL singleton page title.
DString	trServiceGeneratedFromFiles (bool single) override
	UNO IDL service page.
DString	trSingletonGeneratedFromFiles (bool single) override
	UNO IDL singleton page.
DString	trDesignUnitHierarchy () override
	VHDL design unit hierarchy.
DString	trDesignUnitList () override
	VHDL design unit list.
DString	trDesignUnitMembers () override
	VHDL design unit members.
DString	trDesignUnitListDescription () override
	VHDL design unit list description.
DString	trDesignUnitIndex () override
	VHDL design unit index.
DString	trDesignUnits () override
	VHDL design units.
DString	trFunctionAndProc () override
	VHDL functions/procedures/processes.
DString	trVhdlType (VhdlSpecifier type, bool single) override
	VHDL type.
DString	trCustomReference (const DString &name) override
DString	trConstants () override
DString	trConstantDocumentation () override
DString	trSequences () override
DString	trSequenceDocumentation () override
DString	trDictionaries () override
DString	trDictionaryDocumentation () override
DString	trSliceInterfaces () override
DString	trInterfaceIndex () override
DString	trInterfaceList () override
DString	trInterfaceListDescription () override
DString	trInterfaceHierarchy () override
DString	trInterfaceHierarchyDescription () override
DString	trInterfaceDocumentation () override
DString	trStructs () override
DString	trStructIndex () override
DString	trStructList () override
DString	trStructListDescription () override
DString	trStructDocumentation () override
DString	trExceptionIndex () override
DString	trExceptionList () override
DString	trExceptionListDescription () override
DString	trExceptionHierarchy () override
DString	trExceptionHierarchyDescription () override
DString	trExceptionDocumentation () override
DString	trCompoundReferenceSlice (const DString &clName, ClassDef::CompoundType compType, bool isLocal) override
DString	trOperations () override
DString	trOperationDocumentation () override
DString	trDataMembers () override
DString	trDataMemberDocumentation () override
DString	trDesignUnitDocumentation () override
	VHDL design unit documentation.
DString	trConcept (bool first_capital, bool singular) override
	C++20 concept.
DString	trConceptReference (const DString &conceptName) override
DString	trConceptList () override
DString	trConceptIndex () override
DString	trConceptDocumentation () override
DString	trConceptListDescription (bool extractAll) override
DString	trConceptDefinition () override
DString	trPackageList () override
DString	trFlowchart () override
DString	trRelatedSymbols () override
DString	trRelatedSymbolsSubscript () override
DString	trRelatedSymbolDocumentation () override
DString	trCompoundType (ClassDef::CompoundType compType, SrcLangExt lang) override
DString	trFileMembersDescriptionTotal (FileMemberHighlight::Enum hl) override
DString	trCompoundMembersDescriptionTotal (ClassMemberHighlight::Enum hl) override
DString	trNamespaceMembersDescriptionTotal (NamespaceMemberHighlight::Enum hl) override
DString	trDefinition () override
DString	trDeclaration () override
DString	trTopics () override
DString	trTopicDocumentation () override
DString	trTopicList () override
DString	trTopicIndex () override
DString	trTopicListDescription () override
DString	trModuleMembersDescriptionTotal (ModuleMemberHighlight::Enum hl) override
DString	trExportedModules () override
DString	trCopyToClipboard () override
DString	trImportant () override
DString	trRequirements () override
DString	trRequirementID () override
DString	trSatisfies (bool singular) override
DString	trSatisfiedBy (const DString &list) override
DString	trUnsatisfiedRequirements () override
DString	trUnsatisfiedRequirementsText (bool singular, const DString &list) override
DString	trVerifies (bool singular) override
DString	trVerifiedBy (const DString &list) override
DString	trUnverifiedRequirements () override
DString	trUnverifiedRequirementsText (bool singular, const DString &list) override
Public Member Functions inherited from Translator
virtual DString	updateNeededMessage ()
virtual DString	latexFontenc ()
virtual DString	latexFont ()
virtual DString	latexDocumentPre ()
virtual DString	latexDocumentPost ()
virtual DString	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
DString	p_latexCommandName (const DString &latexCmd)
DString	createNoun (bool first_capital, bool singular, const DString &base, const DString &plurSuffix, const DString &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 41 of file translator_en.h.

Member Function Documentation

◆ getLanguageString()

DString 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 80 of file translator_en.h.

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

◆ idLanguage()

DString 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 53 of file translator_en.h.

54 { return "english"; }

◆ latexLanguageSupportCommand()

DString 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 70 of file translator_en.h.

    {
      return "";
    }

◆ trAdditionalInheritedMembers()

DString TranslatorEnglish::trAdditionalInheritedMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1881 of file translator_en.h.

1882 { return "Additional Inherited Members"; }

Referenced by TranslatorAdapter_1_8_0::trAdditionalInheritedMembers().

◆ trAll()

DString 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 1399 of file translator_en.h.

    {
      return "All";
    }

◆ trAndMore()

DString TranslatorEnglish::trAndMore ( const DString & number )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1859 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_0::trAndMore().

◆ trAttention()

DString TranslatorEnglish::trAttention ( )

inlineoverridevirtual

Implements Translator.

Definition at line 976 of file translator_en.h.

    {
      return "Attention";
    }

◆ trAuthor()

DString 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 1272 of file translator_en.h.

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

References Translator::createNoun().

◆ trBug()

DString TranslatorEnglish::trBug ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1144 of file translator_en.h.

    {
      return "Bug";
    }

◆ trBugList()

DString TranslatorEnglish::trBugList ( )

inlineoverridevirtual

Used as the header of the bug list

Implements Translator.

Definition at line 1149 of file translator_en.h.

    {
      return "Bug List";
    }

◆ trCallerGraph()

DString TranslatorEnglish::trCallerGraph ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1518 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_4_6::trCallerGraph().

◆ trCallGraph()

DString TranslatorEnglish::trCallGraph ( )

inlineoverridevirtual

Put in front of the call graph for a function.

Implements Translator.

Definition at line 1404 of file translator_en.h.

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

◆ trCiteReferences()

DString TranslatorEnglish::trCiteReferences ( )

inlineoverridevirtual

Header for the page with bibliographic citations

Implements Translator.

Definition at line 1835 of file translator_en.h.

1836 { return "Bibliography"; }

Referenced by TranslatorAdapter_1_7_5::trCiteReferences().

◆ trClass()

DString 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 1207 of file translator_en.h.

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

References Translator::createNoun().

Referenced by trCompoundType().

◆ trClassDiagram()

DString TranslatorEnglish::trClassDiagram ( const DString & clName )

inlineoverridevirtual

this text is put before a class diagram

Implements Translator.

Definition at line 530 of file translator_en.h.

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

◆ trClassDocumentation()

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

DString TranslatorEnglish::trClasses ( )

inlineoverridevirtual

Used for Java classes in the summary section of Java packages

Implements Translator.

Definition at line 1107 of file translator_en.h.

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

References Config_getBool.

◆ trClassHierarchy()

DString TranslatorEnglish::trClassHierarchy ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 187 of file translator_en.h.

188 { return "Class Hierarchy"; }

◆ trClassHierarchyDescription()

DString TranslatorEnglish::trClassHierarchyDescription ( )

inlineoverridevirtual

This is an introduction to the class hierarchy.

Implements Translator.

Definition at line 246 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()

DString 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 1919 of file translator_en.h.

    {
      return "Class Methods";
    }

Referenced by TranslatorAdapter_1_8_2::trClassMethods().

◆ trCode()

DString TranslatorEnglish::trCode ( )

inlineoverridevirtual

Text used the source code in the file index

Implements Translator.

Definition at line 876 of file translator_en.h.

    {
      return "code";
    }

◆ trCollaborationDiagram()

DString TranslatorEnglish::trCollaborationDiagram ( const DString & clName )

inlineoverridevirtual

this text is put before a collaboration diagram

Implements Translator.

Definition at line 831 of file translator_en.h.

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

◆ trCompoundIndex()

DString TranslatorEnglish::trCompoundIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 384 of file translator_en.h.

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

References Config_getBool.

◆ trCompoundIndexFortran()

DString 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 1573 of file translator_en.h.

1574 { return "Data Type Index"; }

Referenced by TranslatorAdapter_1_6_0::trCompoundIndexFortran().

◆ trCompoundList()

DString TranslatorEnglish::trCompoundList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 191 of file translator_en.h.

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

References Config_getBool.

◆ trCompoundListDescription()

DString TranslatorEnglish::trCompoundListDescription ( )

inlineoverridevirtual

This is an introduction to the annotated compound list.

Implements Translator.

Definition at line 269 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()

DString TranslatorEnglish::trCompoundListDescriptionFortran ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1546 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_6_0::trCompoundListDescriptionFortran().

◆ trCompoundListFortran()

DString 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 1538 of file translator_en.h.

1539 { return "Data Types List"; }

Referenced by TranslatorAdapter_1_6_0::trCompoundListFortran().

◆ trCompoundMembers()

DString TranslatorEnglish::trCompoundMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 208 of file translator_en.h.

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

References Config_getBool.

◆ trCompoundMembersDescription()

DString TranslatorEnglish::trCompoundMembersDescription ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 288 of file translator_en.h.

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

DString TranslatorEnglish::trCompoundMembersDescriptionFortran ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1550 of file translator_en.h.

    {
      DString 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;
    }

Referenced by TranslatorAdapter_1_6_0::trCompoundMembersDescriptionFortran().

◆ trCompoundMembersDescriptionTotal()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2418 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      DString 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()

DString TranslatorEnglish::trCompoundMembersFortran ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1542 of file translator_en.h.

1543 { return "Data Fields"; }

Referenced by TranslatorAdapter_1_6_0::trCompoundMembersFortran().

◆ trCompoundReference()

DString TranslatorEnglish::trCompoundReference	(	const DString &	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 605 of file translator_en.h.

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

DString TranslatorEnglish::trCompoundReferenceFortran	(	const DString &	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 1614 of file translator_en.h.

    {
      DString 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.

Referenced by TranslatorAdapter_1_6_0::trCompoundReferenceFortran().

◆ trCompoundReferenceSlice()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2209 of file translator_en.h.

    {
      DString 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.

Referenced by TranslatorAdapter_1_8_15::trCompoundReferenceSlice().

◆ trCompounds()

DString 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 506 of file translator_en.h.

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

References Config_getBool.

◆ trCompoundType()

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

inlineoverridevirtual

the compound type as used for the xrefitems

Implements Translator.

Definition at line 2344 of file translator_en.h.

    {
      DString result;
      switch(compType)
      {
        case ClassDef::Class:
          if (lang == SrcLangExt::Fortran) result=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, ClassDef::Interface, ClassDef::Protocol, ClassDef::Service, ClassDef::Singleton, ClassDef::Struct, trClass(), trType(), and ClassDef::Union.

Referenced by TranslatorAdapter_1_9_6::trCompoundType().

◆ trConcept()

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

inlineoverridevirtual

C++20 concept.

Implements Translator.

Definition at line 2257 of file translator_en.h.

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

References Translator::createNoun().

Referenced by TranslatorAdapter_1_9_2::trConcept().

◆ trConceptDefinition()

DString TranslatorEnglish::trConceptDefinition ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2291 of file translator_en.h.

    {
      return "Concept definition";
    }

Referenced by TranslatorAdapter_1_9_2::trConceptDefinition().

◆ trConceptDocumentation()

DString TranslatorEnglish::trConceptDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2278 of file translator_en.h.

2279 { return "Concept Documentation"; }

Referenced by TranslatorAdapter_1_9_2::trConceptDocumentation().

◆ trConceptIndex()

DString TranslatorEnglish::trConceptIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2274 of file translator_en.h.

2275 { return "Concept Index"; }

Referenced by TranslatorAdapter_1_9_2::trConceptIndex().

◆ trConceptList()

DString TranslatorEnglish::trConceptList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2270 of file translator_en.h.

2271 { return "Concept List"; }

Referenced by TranslatorAdapter_1_9_2::trConceptList().

◆ trConceptListDescription()

DString TranslatorEnglish::trConceptListDescription ( bool extractAll )

inlineoverridevirtual

used as an introduction to the concept list

Implements Translator.

Definition at line 2282 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_9_2::trConceptListDescription().

◆ trConceptReference()

DString TranslatorEnglish::trConceptReference ( const DString & conceptName )

inlineoverridevirtual

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

Implements Translator.

Definition at line 2262 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_9_2::trConceptReference().

◆ trConstantDocumentation()

DString TranslatorEnglish::trConstantDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2117 of file translator_en.h.

    {
        return "Constant Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trConstantDocumentation().

◆ trConstantGroupReference()

DString TranslatorEnglish::trConstantGroupReference ( const DString & namespaceName )

inlineoverridevirtual

UNO IDL constant groups.

Implements Translator.

Definition at line 1956 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_4::trConstantGroupReference().

◆ trConstantGroups()

DString TranslatorEnglish::trConstantGroups ( )

inlineoverridevirtual

UNO IDL constant groups.

Implements Translator.

Definition at line 1952 of file translator_en.h.

1953 { return "Constant Groups"; }

Referenced by TranslatorAdapter_1_8_4::trConstantGroups().

◆ trConstants()

DString TranslatorEnglish::trConstants ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2113 of file translator_en.h.

    {
        return "Constants";
    }

Referenced by TranslatorAdapter_1_8_15::trConstants().

◆ trConstructorDocumentation()

DString TranslatorEnglish::trConstructorDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 841 of file translator_en.h.

    {
      return "Constructor & Destructor Documentation";
    }

◆ trCopyright()

DString TranslatorEnglish::trCopyright ( )

inlineoverridevirtual

Text for copyright paragraph

Implements Translator.

Definition at line 1839 of file translator_en.h.

1840 { return "Copyright"; }

Referenced by TranslatorAdapter_1_7_5::trCopyright().

◆ trCopyToClipboard()

DString TranslatorEnglish::trCopyToClipboard ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2602 of file translator_en.h.

    {
      return "Copy to clipboard";
    }

Referenced by TranslatorAdapter_1_10_0::trCopyToClipboard().

◆ trCustomReference()

DString TranslatorEnglish::trCustomReference ( const DString & name )

inlineoverridevirtual

Implements Translator.

Definition at line 2109 of file translator_en.h.

2110 { return name+" Reference"; }

Referenced by TranslatorAdapter_1_8_15::trCustomReference().

◆ trDataMemberDocumentation()

DString TranslatorEnglish::trDataMemberDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2239 of file translator_en.h.

    {
        return "Data Member Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trDataMemberDocumentation().

◆ trDataMembers()

DString TranslatorEnglish::trDataMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2235 of file translator_en.h.

    {
        return "Data Members";
    }

Referenced by TranslatorAdapter_1_8_15::trDataMembers().

◆ trDataTypes()

DString 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 1597 of file translator_en.h.

1598 { return "Data Types"; }

Referenced by TranslatorAdapter_1_6_0::trDataTypes().

◆ trDate()

DString TranslatorEnglish::trDate ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 544 of file translator_en.h.

545 { return "Date"; }

◆ trDateTime()

DString 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 1792 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" };
      DString 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)
      {
        DString stime;
        stime.sprintf("%.2d:%.2d:%.2d",hour,minutes,seconds);
        sdate+=stime;
      }
      return sdate;
    }

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

Referenced by TranslatorAdapter_1_7_5::trDateTime().

◆ trDayOfWeek()

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

inlineoverridevirtual

Implements Translator.

Definition at line 1812 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()

DString TranslatorEnglish::trDayPeriod ( bool period )

inlineoverridevirtual

Implements Translator.

Definition at line 1824 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_7_5::trDayPeriod().

◆ trDeclaration()

DString TranslatorEnglish::trDeclaration ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2538 of file translator_en.h.

2538{ return "Declaration";}

Referenced by TranslatorAdapter_1_9_6::trDeclaration().

◆ trDefinedAtLineInSourceFile()

DString TranslatorEnglish::trDefinedAtLineInSourceFile ( )

inlineoverridevirtual

Implements Translator.

Definition at line 808 of file translator_en.h.

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

◆ trDefinedIn()

DString TranslatorEnglish::trDefinedIn ( )

inlineoverridevirtual

put after an undocumented member in the list of all members

Implements Translator.

Definition at line 175 of file translator_en.h.

176 { return "defined in"; }

◆ trDefinedInSourceFile()

DString TranslatorEnglish::trDefinedInSourceFile ( )

inlineoverridevirtual

Implements Translator.

Definition at line 812 of file translator_en.h.

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

◆ trDefineDocumentation()

DString 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 476 of file translator_en.h.

477 { return "Macro Definition Documentation"; }

◆ trDefines()

DString 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 440 of file translator_en.h.

441 { return "Macros"; }

◆ trDefineValue()

DString TranslatorEnglish::trDefineValue ( )

inlineoverridevirtual

Text shown before a multi-line define

Implements Translator.

Definition at line 1134 of file translator_en.h.

    {
      return "Value:";
    }

◆ trDefinition()

DString TranslatorEnglish::trDefinition ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2537 of file translator_en.h.

2537{ return "Definition";}

Referenced by TranslatorAdapter_1_9_6::trDefinition().

◆ trDeprecated()

DString TranslatorEnglish::trDeprecated ( )

inlineoverridevirtual

Implements Translator.

Definition at line 821 of file translator_en.h.

    {
      return "Deprecated";
    }

◆ trDeprecatedList()

DString TranslatorEnglish::trDeprecatedList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1327 of file translator_en.h.

    {
      return "Deprecated List";
    }

◆ trDesignUnitDocumentation()

DString TranslatorEnglish::trDesignUnitDocumentation ( )

inlineoverridevirtual

VHDL design unit documentation.

Implements Translator.

Definition at line 2249 of file translator_en.h.

2250 { return "Design Unit Documentation"; }

Referenced by trClassDocumentation(), and TranslatorAdapter_1_8_19::trDesignUnitDocumentation().

◆ trDesignUnitHierarchy()

DString TranslatorEnglish::trDesignUnitHierarchy ( )

inlineoverridevirtual

VHDL design unit hierarchy.

Implements Translator.

Definition at line 2000 of file translator_en.h.

2001 { return "Design Unit Hierarchy"; }

Referenced by TranslatorAdapter_1_8_15::trDesignUnitHierarchy().

◆ trDesignUnitIndex()

DString TranslatorEnglish::trDesignUnitIndex ( )

inlineoverridevirtual

VHDL design unit index.

Implements Translator.

Definition at line 2015 of file translator_en.h.

2016 { return "Design Unit Index"; }

Referenced by TranslatorAdapter_1_8_15::trDesignUnitIndex().

◆ trDesignUnitList()

DString TranslatorEnglish::trDesignUnitList ( )

inlineoverridevirtual

VHDL design unit list.

Implements Translator.

Definition at line 2003 of file translator_en.h.

2004 { return "Design Unit List"; }

Referenced by TranslatorAdapter_1_8_15::trDesignUnitList().

◆ trDesignUnitListDescription()

DString TranslatorEnglish::trDesignUnitListDescription ( )

inlineoverridevirtual

VHDL design unit list description.

Implements Translator.

Definition at line 2009 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_15::trDesignUnitListDescription().

◆ trDesignUnitMembers()

DString TranslatorEnglish::trDesignUnitMembers ( )

inlineoverridevirtual

VHDL design unit members.

Implements Translator.

Definition at line 2006 of file translator_en.h.

2007 { return "Design Unit Members"; }

Referenced by TranslatorAdapter_1_8_15::trDesignUnitMembers().

◆ trDesignUnits()

DString TranslatorEnglish::trDesignUnits ( )

inlineoverridevirtual

VHDL design units.

Implements Translator.

Definition at line 2018 of file translator_en.h.

2019 { return "Design Units"; }

Referenced by TranslatorAdapter_1_8_15::trDesignUnits().

◆ trDetailedDescription()

DString TranslatorEnglish::trDetailedDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 95 of file translator_en.h.

96 { return "Detailed Description"; }

◆ trDetailLevel()

DString TranslatorEnglish::trDetailLevel ( )

inlineoverridevirtual

Detail level selector shown for hierarchical indices

Implements Translator.

Definition at line 1851 of file translator_en.h.

1852 { return "detail level"; }

Referenced by TranslatorAdapter_1_8_0::trDetailLevel().

◆ trDetails()

DString TranslatorEnglish::trDetails ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 99 of file translator_en.h.

100 { return "Details"; }

◆ trDictionaries()

DString TranslatorEnglish::trDictionaries ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2129 of file translator_en.h.

    {
        return "Dictionaries";
    }

Referenced by TranslatorAdapter_1_8_15::trDictionaries().

◆ trDictionaryDocumentation()

DString TranslatorEnglish::trDictionaryDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2133 of file translator_en.h.

    {
        return "Dictionary Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trDictionaryDocumentation().

◆ trDir()

DString 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 1494 of file translator_en.h.

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

References Translator::createNoun().

◆ trDirDepGraph()

DString TranslatorEnglish::trDirDepGraph ( const DString & name )

inlineoverridevirtual

Header for the graph showing the directory dependencies

Implements Translator.

Definition at line 1843 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_7_5::trDirDepGraph().

◆ trDirDocumentation()

DString TranslatorEnglish::trDirDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1476 of file translator_en.h.

1477 { return "Directory Documentation"; }

◆ trDirectories()

DString 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 1482 of file translator_en.h.

1483 { return "Directories"; }

◆ trDirIndex()

DString TranslatorEnglish::trDirIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1470 of file translator_en.h.

1471 { return "Directory Hierarchy"; }

◆ trDirReference()

DString TranslatorEnglish::trDirReference ( const DString & dirName )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1488 of file translator_en.h.

1489 { DString result=dirName; result+=" Directory Reference"; return result; }

◆ trDirRelation()

DString TranslatorEnglish::trDirRelation ( const DString & name )

inlineoverridevirtual

directory relation for name

Implements Translator.

Definition at line 1731 of file translator_en.h.

    {
      return name+" Relation";
    }

Referenced by TranslatorAdapter_1_6_0::trDirRelation().

◆ trDocumentation()

DString TranslatorEnglish::trDocumentation ( const DString & projName )

inlineoverridevirtual

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

Implements Translator.

Definition at line 366 of file translator_en.h.

367 { return (!projName.empty()?projName + " " : "") + "Documentation"; }

DString::empty

bool empty() const

Returns true iff the string is empty (std::string compatible alias for isEmpty()).

Definition dstring.h:152

References DString::empty().

◆ trEnumerations()

DString 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 452 of file translator_en.h.

453 { return "Enumerations"; }

◆ trEnumerationTypeDocumentation()

DString 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 488 of file translator_en.h.

489 { return "Enumeration Type Documentation"; }

◆ trEnumerationValueDocumentation()

DString 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 1526 of file translator_en.h.

1527 { return "Enumerator Documentation"; }

Referenced by TranslatorAdapter_1_4_6::trEnumerationValueDocumentation().

◆ trEnumerationValues()

DString 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 470 of file translator_en.h.

471 { return "Enumerator"; }

◆ trEnumGeneratedFromFiles()

DString TranslatorEnglish::trEnumGeneratedFromFiles ( bool single )

inlineoverridevirtual

Used file list for a Java enum

Implements Translator.

Definition at line 1863 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_0::trEnumGeneratedFromFiles().

◆ trEnumName()

DString TranslatorEnglish::trEnumName ( )

inlineoverridevirtual

put after an enum name in the list of all members

Implements Translator.

Definition at line 167 of file translator_en.h.

168 { return "enum name"; }

◆ trEnumReference()

DString TranslatorEnglish::trEnumReference ( const DString & name )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1871 of file translator_en.h.

1872 { return name+" Enum Reference"; }

Referenced by TranslatorAdapter_1_8_0::trEnumReference().

◆ trEnumValue()

DString TranslatorEnglish::trEnumValue ( )

inlineoverridevirtual

put after an enum value in the list of all members

Implements Translator.

Definition at line 171 of file translator_en.h.

172 { return "enum value"; }

◆ trEventDocumentation()

DString TranslatorEnglish::trEventDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1344 of file translator_en.h.

    {
      return "Event Documentation";
    }

◆ trEvents()

DString TranslatorEnglish::trEvents ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1339 of file translator_en.h.

    {
      return "Events";
    }

◆ trExamples()

DString TranslatorEnglish::trExamples ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 238 of file translator_en.h.

239 { return "Examples"; }

◆ trExamplesDescription()

DString TranslatorEnglish::trExamplesDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 352 of file translator_en.h.

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

◆ trExceptionDocumentation()

DString TranslatorEnglish::trExceptionDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2205 of file translator_en.h.

    {
        return "Exception Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trExceptionDocumentation().

◆ trExceptionHierarchy()

DString TranslatorEnglish::trExceptionHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2197 of file translator_en.h.

    {
        return "Exception Hierarchy";
    }

Referenced by TranslatorAdapter_1_8_15::trExceptionHierarchy().

◆ trExceptionHierarchyDescription()

DString TranslatorEnglish::trExceptionHierarchyDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2201 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_15::trExceptionHierarchyDescription().

◆ trExceptionIndex()

DString TranslatorEnglish::trExceptionIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2185 of file translator_en.h.

    {
        return "Exception Index";
    }

Referenced by TranslatorAdapter_1_8_15::trExceptionIndex().

◆ trExceptionList()

DString TranslatorEnglish::trExceptionList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2189 of file translator_en.h.

    {
        return "Exception List";
    }

Referenced by TranslatorAdapter_1_8_15::trExceptionList().

◆ trExceptionListDescription()

DString TranslatorEnglish::trExceptionListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2193 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_15::trExceptionListDescription().

◆ trExceptions()

DString TranslatorEnglish::trExceptions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 560 of file translator_en.h.

561 { return "Exceptions"; }

◆ trExportedModules()

DString TranslatorEnglish::trExportedModules ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2593 of file translator_en.h.

    {
      return "Exported Modules";
    }

Referenced by TranslatorAdapter_1_9_8::trExportedModules().

◆ trExtendsClass()

DString 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 1911 of file translator_en.h.

    {
      return "Extends class @0.";
    }

Referenced by TranslatorAdapter_1_8_2::trExtendsClass().

◆ trFile()

DString 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 1216 of file translator_en.h.

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

References Translator::createNoun().

◆ trFileDocumentation()

DString 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 430 of file translator_en.h.

431 { return "File Documentation"; }

◆ trFileIn()

DString TranslatorEnglish::trFileIn ( const DString & 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 1768 of file translator_en.h.

    {
      return "File in "+name;
    }

Referenced by TranslatorAdapter_1_7_5::trFileIn().

◆ trFileIndex()

DString 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 399 of file translator_en.h.

400 { return "File Index"; }

◆ trFileList()

DString TranslatorEnglish::trFileList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 204 of file translator_en.h.

205 { return "File List"; }

◆ trFileListDescription()

DString TranslatorEnglish::trFileListDescription ( bool extractAll )

inlineoverridevirtual

This is an introduction to the list with all files.

Implements Translator.

Definition at line 260 of file translator_en.h.

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

◆ trFileMembers()

DString TranslatorEnglish::trFileMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 221 of file translator_en.h.

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

References Config_getBool.

◆ trFileMembersDescription()

DString TranslatorEnglish::trFileMembersDescription ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 330 of file translator_en.h.

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

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

inlineoverridevirtual

Implements Translator.

Definition at line 2366 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      DString 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()

DString TranslatorEnglish::trFileReference ( const DString & fileName )

inlineoverridevirtual

used as the title of the HTML page of a file

Implements Translator.

Definition at line 627 of file translator_en.h.

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

◆ trFlowchart()

DString 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 2310 of file translator_en.h.

2311 { return "Flowchart:"; }

Referenced by TranslatorAdapter_1_9_5::trFlowchart().

◆ trFriends()

DString 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 587 of file translator_en.h.

588 { return "Friends"; }

◆ trFunctionAndProc()

DString TranslatorEnglish::trFunctionAndProc ( )

inlineoverridevirtual

VHDL functions/procedures/processes.

Implements Translator.

Definition at line 2021 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_15::trFunctionAndProc().

◆ trFunctionDocumentation()

DString 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 494 of file translator_en.h.

495 { return "Function Documentation"; }

◆ trFunctions()

DString 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 458 of file translator_en.h.

459 { return "Functions"; }

◆ trGeneratedAt()

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

inlineoverridevirtual

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

Implements Translator.

Definition at line 521 of file translator_en.h.

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

References DString::empty().

◆ trGeneratedAutomatically()

DString TranslatorEnglish::trGeneratedAutomatically ( const DString & 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 159 of file translator_en.h.

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

References DString::empty().

◆ trGeneratedBy()

DString TranslatorEnglish::trGeneratedBy ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 564 of file translator_en.h.

565 { return "Generated by"; }

◆ trGeneratedFromFiles()

DString 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 764 of file translator_en.h.

    { // single is true implies a single file
      bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
      DString 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()

DString 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 1681 of file translator_en.h.

    {
      // single is true implies a single file
      DString 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.

Referenced by TranslatorAdapter_1_6_0::trGeneratedFromFilesFortran().

◆ trGlobal()

DString 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 1261 of file translator_en.h.

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

References Translator::createNoun().

◆ trGlobalNamespace()

DString TranslatorEnglish::trGlobalNamespace ( )

inlineoverridevirtual

Label used for search results in the global namespace

Implements Translator.

Definition at line 1743 of file translator_en.h.

    {
      return "Global Namespace";
    }

Referenced by TranslatorAdapter_1_6_0::trGlobalNamespace().

◆ trGotoDocumentation()

DString TranslatorEnglish::trGotoDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 851 of file translator_en.h.

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

◆ trGotoGraphicalHierarchy()

DString TranslatorEnglish::trGotoGraphicalHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 884 of file translator_en.h.

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

◆ trGotoSourceCode()

DString TranslatorEnglish::trGotoSourceCode ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 846 of file translator_en.h.

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

◆ trGotoTextualHierarchy()

DString TranslatorEnglish::trGotoTextualHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 888 of file translator_en.h.

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

◆ trGraphicalHierarchy()

DString TranslatorEnglish::trGraphicalHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 880 of file translator_en.h.

    {
      return "Graphical Class Hierarchy";
    }

◆ trGroup()

DString 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 1234 of file translator_en.h.

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

References Translator::createNoun().

◆ trHierarchicalIndex()

DString TranslatorEnglish::trHierarchicalIndex ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 378 of file translator_en.h.

379 { return "Hierarchical Index"; }

◆ trImplementedFromList()

DString 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 1295 of file translator_en.h.

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

References trWriteList().

◆ trImplementedInList()

DString 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 1303 of file translator_en.h.

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

References trWriteList().

◆ trImportant()

DString TranslatorEnglish::trImportant ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2609 of file translator_en.h.

    {
      return "Important";
    }

Referenced by TranslatorAdapter_1_11_0::trImportant().

◆ trInclByDepGraph()

DString TranslatorEnglish::trInclByDepGraph ( )

inlineoverridevirtual

Implements Translator.

Definition at line 980 of file translator_en.h.

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

◆ trInclDepGraph()

DString TranslatorEnglish::trInclDepGraph ( const DString & fName )

inlineoverridevirtual

this text is put before an include dependency graph

Implements Translator.

Definition at line 836 of file translator_en.h.

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

◆ trIncludesFileIn()

DString TranslatorEnglish::trIncludesFileIn ( const DString & 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 1777 of file translator_en.h.

    {
      return "Includes file in "+name;
    }

Referenced by TranslatorAdapter_1_7_5::trIncludesFileIn().

◆ trIncludingInheritedMembers()

DString TranslatorEnglish::trIncludingInheritedMembers ( )

inlineoverridevirtual

this is the remainder of the sentence after the class name

Implements Translator.

Definition at line 153 of file translator_en.h.

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

◆ trInheritedByList()

DString 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 698 of file translator_en.h.

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

References trWriteList().

◆ trInheritedFrom()

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

inlineoverridevirtual

Used for a section containing inherited members

Implements Translator.

Definition at line 1875 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_0::trInheritedFrom().

◆ trInheritsList()

DString 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 690 of file translator_en.h.

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

References trWriteList().

◆ trInitialValue()

DString TranslatorEnglish::trInitialValue ( )

inlineoverridevirtual

Text shown before a multi-line variable/enum initialization

Implements Translator.

Definition at line 871 of file translator_en.h.

    {
      return "Initial value:";
    }

◆ trInstanceMethods()

DString 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 1927 of file translator_en.h.

    {
      return "Instance Methods";
    }

Referenced by TranslatorAdapter_1_8_2::trInstanceMethods().

◆ trInterfaceDocumentation()

DString TranslatorEnglish::trInterfaceDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2161 of file translator_en.h.

    {
        return "Interface Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trInterfaceDocumentation().

◆ trInterfaceHierarchy()

DString TranslatorEnglish::trInterfaceHierarchy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2153 of file translator_en.h.

    {
        return "Interface Hierarchy";
    }

Referenced by TranslatorAdapter_1_8_15::trInterfaceHierarchy().

◆ trInterfaceHierarchyDescription()

DString TranslatorEnglish::trInterfaceHierarchyDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2157 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_15::trInterfaceHierarchyDescription().

◆ trInterfaceIndex()

DString TranslatorEnglish::trInterfaceIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2141 of file translator_en.h.

    {
        return "Interface Index";
    }

Referenced by TranslatorAdapter_1_8_15::trInterfaceIndex().

◆ trInterfaceList()

DString TranslatorEnglish::trInterfaceList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2145 of file translator_en.h.

    {
        return "Interface List";
    }

Referenced by TranslatorAdapter_1_8_15::trInterfaceList().

◆ trInterfaceListDescription()

DString TranslatorEnglish::trInterfaceListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2149 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_15::trInterfaceListDescription().

◆ trInterfaces()

DString TranslatorEnglish::trInterfaces ( )

inlineoverridevirtual

old style UNO IDL services: implemented interfaces

Implements Translator.

Definition at line 1944 of file translator_en.h.

1945 { return "Exported Interfaces"; }

Referenced by TranslatorAdapter_1_8_4::trInterfaces().

◆ trInvariant()

DString TranslatorEnglish::trInvariant ( )

inlineoverridevirtual

Text for the \invariant command

Implements Translator.

Definition at line 866 of file translator_en.h.

    {
      return "Invariant";
    }

◆ trISOLang()

DString TranslatorEnglish::trISOLang ( )

inlineoverridevirtual

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 75 of file translator_en.h.

    {
      return "en-US";
    }

◆ trLegend()

DString TranslatorEnglish::trLegend ( )

inlineoverridevirtual

text for the link to the legend page

Implements Translator.

Definition at line 1067 of file translator_en.h.

    {
      return "legend";
    }

◆ trLegendDocs()

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

DString TranslatorEnglish::trLegendTitle ( )

inlineoverridevirtual

title of the graph legend page

Implements Translator.

Definition at line 995 of file translator_en.h.

    {
      return "Graph Legend";
    }

◆ trListOfAllMembers()

DString TranslatorEnglish::trListOfAllMembers ( )

inlineoverridevirtual

put in the class documentation

Implements Translator.

Definition at line 141 of file translator_en.h.

142 { return "List of all members"; }

◆ trLoading()

DString TranslatorEnglish::trLoading ( )

inlineoverridevirtual

Loading message shown when loading search results

Implements Translator.

Definition at line 1737 of file translator_en.h.

    {
      return "Loading...";
    }

Referenced by TranslatorAdapter_1_6_0::trLoading().

◆ trMainPage()

DString TranslatorEnglish::trMainPage ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 795 of file translator_en.h.

796 { return "Main Page"; }

◆ trMember()

DString 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 1252 of file translator_en.h.

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

References Translator::createNoun().

◆ trMemberDataDocumentation()

DString TranslatorEnglish::trMemberDataDocumentation ( )

inlineoverridevirtual

header that is put before the list of member attributes.

Implements Translator.

Definition at line 124 of file translator_en.h.

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

References Config_getBool.

◆ trMemberEnumerationDocumentation()

DString TranslatorEnglish::trMemberEnumerationDocumentation ( )

inlineoverridevirtual

header that is put before the list of enumerations.

Implements Translator.

Definition at line 107 of file translator_en.h.

108 { return "Member Enumeration Documentation"; }

◆ trMemberFunctionDocumentation()

DString TranslatorEnglish::trMemberFunctionDocumentation ( )

inlineoverridevirtual

header that is put before the list of member functions.

Implements Translator.

Definition at line 111 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()

DString TranslatorEnglish::trMemberFunctionDocumentationFortran ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1534 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_6_0::trMemberFunctionDocumentationFortran().

◆ trMemberList()

DString TranslatorEnglish::trMemberList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 145 of file translator_en.h.

146 { return "Member List"; }

◆ trMemberTypedefDocumentation()

DString TranslatorEnglish::trMemberTypedefDocumentation ( )

inlineoverridevirtual

header that is put before the list of typedefs.

Implements Translator.

Definition at line 103 of file translator_en.h.

104 { return "Member Typedef Documentation"; }

◆ trMethodDocumentation()

DString TranslatorEnglish::trMethodDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1934 of file translator_en.h.

    {
      return "Method Documentation";
    }

Referenced by TranslatorAdapter_1_8_2::trMethodDocumentation().

◆ trModule()

DString 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 1673 of file translator_en.h.

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

References Translator::createNoun().

Referenced by TranslatorAdapter_1_6_0::trModule().

◆ trModuleDocumentation()

DString 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 405 of file translator_en.h.

406 { return "Module Documentation"; }

◆ trModuleIndex()

DString 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 372 of file translator_en.h.

373 { return "Module Index"; }

◆ trModuleMembersDescriptionTotal()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2554 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      DString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="module ";
      DString singularResult = "";
      DString 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.empty() ? 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, DString::empty(), ModuleMemberHighlight::Enums, ModuleMemberHighlight::EnumValues, ModuleMemberHighlight::Functions, ModuleMemberHighlight::Total, ModuleMemberHighlight::Typedefs, and ModuleMemberHighlight::Variables.

Referenced by TranslatorAdapter_1_9_8::trModuleMembersDescriptionTotal().

◆ trModuleReference()

DString TranslatorEnglish::trModuleReference ( const DString & namespaceName )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1635 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_6_0::trModuleReference().

◆ trModules()

DString 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 183 of file translator_en.h.

184 { return "Modules"; }

◆ trModulesDescription()

DString TranslatorEnglish::trModulesDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 360 of file translator_en.h.

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

◆ trModulesIndex()

DString 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 1666 of file translator_en.h.

1667 { return "Modules Index"; }

Referenced by TranslatorAdapter_1_6_0::trModulesIndex().

◆ trModulesList()

DString TranslatorEnglish::trModulesList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1601 of file translator_en.h.

1602 { return "Modules List"; }

Referenced by TranslatorAdapter_1_6_0::trModulesList().

◆ trModulesListDescription()

DString TranslatorEnglish::trModulesListDescription ( bool extractAll )

inlineoverridevirtual

used as an introduction to the modules list (Fortran)

Implements Translator.

Definition at line 1605 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_6_0::trModulesListDescription().

◆ trModulesMemberDescription()

DString TranslatorEnglish::trModulesMemberDescription ( bool extractAll )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1647 of file translator_en.h.

    {
      DString 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;
    }

Referenced by TranslatorAdapter_1_6_0::trModulesMemberDescription().

◆ trModulesMembers()

DString TranslatorEnglish::trModulesMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1643 of file translator_en.h.

1644 { return "Module Members"; }

Referenced by TranslatorAdapter_1_6_0::trModulesMembers().

◆ trMonth()

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

inlineoverridevirtual

Implements Translator.

Definition at line 1818 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()

DString TranslatorEnglish::trMore ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 137 of file translator_en.h.

138 { return "More..."; }

◆ trNamespace()

DString 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 1225 of file translator_en.h.

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

References Translator::createNoun().

◆ trNamespaceDocumentation()

DString 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 744 of file translator_en.h.

745 { return "Namespace Documentation"; }

◆ trNamespaceIndex()

DString 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 738 of file translator_en.h.

739 { return "Namespace Index"; }

◆ trNamespaceList()

DString TranslatorEnglish::trNamespaceList ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 572 of file translator_en.h.

573 { return "Namespace List"; }

◆ trNamespaceListDescription()

DString TranslatorEnglish::trNamespaceListDescription ( bool extractAll )

inlineoverridevirtual

used as an introduction to the namespace list

Implements Translator.

Definition at line 576 of file translator_en.h.

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

◆ trNamespaceMemberDescription()

DString TranslatorEnglish::trNamespaceMemberDescription ( bool extractAll )

inlineoverridevirtual

This is an introduction to the page with all namespace members

Implements Translator.

Definition at line 724 of file translator_en.h.

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

DString TranslatorEnglish::trNamespaceMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 720 of file translator_en.h.

721 { return "Namespace Members"; }

◆ trNamespaceMembersDescriptionTotal()

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

inlineoverridevirtual

Implements Translator.

Definition at line 2491 of file translator_en.h.

    {
      bool extractAll = Config_getBool(EXTRACT_ALL);
      DString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="namespace ";
      DString singularResult = "";
      DString 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.empty() ? 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, DString::empty(), NamespaceMemberHighlight::Enums, NamespaceMemberHighlight::EnumValues, NamespaceMemberHighlight::Functions, NamespaceMemberHighlight::Sequences, NamespaceMemberHighlight::Total, NamespaceMemberHighlight::Typedefs, and NamespaceMemberHighlight::Variables.

◆ trNamespaceReference()

DString TranslatorEnglish::trNamespaceReference ( const DString & namespaceName )

inlineoverridevirtual

used as the title of the HTML page of a namespace

Implements Translator.

Definition at line 635 of file translator_en.h.

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

◆ trNamespaces()

DString TranslatorEnglish::trNamespaces ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 754 of file translator_en.h.

755 { return "Namespaces"; }

◆ trNoMatches()

DString TranslatorEnglish::trNoMatches ( )

inlineoverridevirtual

Text shown when no search results are found

Implements Translator.

Definition at line 1755 of file translator_en.h.

    {
      return "No Matches";
    }

Referenced by TranslatorAdapter_1_6_0::trNoMatches().

◆ trNote()

DString TranslatorEnglish::trNote ( )

inlineoverridevirtual

Implements Translator.

Definition at line 901 of file translator_en.h.

    {
      return "Note";
    }

◆ trOperationDocumentation()

DString TranslatorEnglish::trOperationDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2231 of file translator_en.h.

    {
        return "Operation Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trOperationDocumentation().

◆ trOperations()

DString TranslatorEnglish::trOperations ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2227 of file translator_en.h.

    {
        return "Operations";
    }

Referenced by TranslatorAdapter_1_8_15::trOperations().

◆ trOverloadText()

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

DString TranslatorEnglish::trPackage ( const DString & name )

inlineoverridevirtual

Used as the title of a Java package

Implements Translator.

Definition at line 1119 of file translator_en.h.

    {
      return "Package "+name;
    }

◆ trPackageAttribs()

DString TranslatorEnglish::trPackageAttribs ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1380 of file translator_en.h.

    {
      return "Package Attributes";
    }

◆ trPackageFunctions()

DString TranslatorEnglish::trPackageFunctions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1362 of file translator_en.h.

    {
      return "Package Functions";
    }

◆ trPackageList()

DString TranslatorEnglish::trPackageList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2300 of file translator_en.h.

2301 { return "Package List"; }

Referenced by TranslatorAdapter_1_9_4::trPackageList().

◆ trPackageListDescription()

DString TranslatorEnglish::trPackageListDescription ( )

inlineoverridevirtual

The description of the package index page

Implements Translator.

Definition at line 1124 of file translator_en.h.

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

◆ trPackageMembers()

DString TranslatorEnglish::trPackageMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 1366 of file translator_en.h.

    {
      return "Package Members";
    }

◆ trPackages()

DString TranslatorEnglish::trPackages ( )

inlineoverridevirtual

The link name in the Quick links header for each page

Implements Translator.

Definition at line 1129 of file translator_en.h.

    {
      return "Packages";
    }

◆ trPackageTypes()

DString TranslatorEnglish::trPackageTypes ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1355 of file translator_en.h.

    {
      return "Package Types";
    }

◆ trPage()

DString 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 1243 of file translator_en.h.

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

References Translator::createNoun().

◆ trPageAbbreviation()

DString 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 801 of file translator_en.h.

802 { return "p."; }

◆ trPageIndex()

DString TranslatorEnglish::trPageIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 892 of file translator_en.h.

    {
      return "Page Index";
    }

◆ trPanelSynchronisationTooltip()

DString 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 1892 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_2::trPanelSynchronisationTooltip().

◆ trParameters()

DString TranslatorEnglish::trParameters ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 556 of file translator_en.h.

557 { return "Parameters"; }

◆ trPostcondition()

DString TranslatorEnglish::trPostcondition ( )

inlineoverridevirtual

Text for the \post command

Implements Translator.

Definition at line 861 of file translator_en.h.

    {
      return "Postcondition";
    }

◆ trPrecondition()

DString TranslatorEnglish::trPrecondition ( )

inlineoverridevirtual

Text for the \pre command

Implements Translator.

Definition at line 856 of file translator_en.h.

    {
      return "Precondition";
    }

◆ trPrivateAttribs()

DString TranslatorEnglish::trPrivateAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 940 of file translator_en.h.

    {
      return "Private Attributes";
    }

◆ trPrivateMembers()

DString TranslatorEnglish::trPrivateMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 656 of file translator_en.h.

657 { return "Private Member Functions"; }

◆ trPrivateSlots()

DString TranslatorEnglish::trPrivateSlots ( )

inlineoverridevirtual

Implements Translator.

Definition at line 658 of file translator_en.h.

659 { return "Private Slots"; }

◆ trPrivateTypes()

DString TranslatorEnglish::trPrivateTypes ( )

inlineoverridevirtual

Implements Translator.

Definition at line 936 of file translator_en.h.

    {
      return "Private Types";
    }

◆ trProperties()

DString TranslatorEnglish::trProperties ( )

inlineoverridevirtual

Used as a section header for IDL properties

Implements Translator.

Definition at line 1092 of file translator_en.h.

    {
      return "Properties";
    }

◆ trPropertyDocumentation()

DString TranslatorEnglish::trPropertyDocumentation ( )

inlineoverridevirtual

Used as a section header for IDL property documentation

Implements Translator.

Definition at line 1097 of file translator_en.h.

    {
      return "Property Documentation";
    }

◆ trProtectedAttribs()

DString TranslatorEnglish::trProtectedAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 928 of file translator_en.h.

    {
      return "Protected Attributes";
    }

◆ trProtectedMembers()

DString TranslatorEnglish::trProtectedMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 650 of file translator_en.h.

651 { return "Protected Member Functions"; }

◆ trProtectedSlots()

DString TranslatorEnglish::trProtectedSlots ( )

inlineoverridevirtual

Implements Translator.

Definition at line 652 of file translator_en.h.

653 { return "Protected Slots"; }

◆ trProtectedTypes()

DString TranslatorEnglish::trProtectedTypes ( )

inlineoverridevirtual

Implements Translator.

Definition at line 924 of file translator_en.h.

    {
      return "Protected Types";
    }

◆ trProvidedByCategory()

DString 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 1902 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_2::trProvidedByCategory().

◆ trPublicAttribs()

DString TranslatorEnglish::trPublicAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 909 of file translator_en.h.

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

References Config_getBool.

◆ trPublicMembers()

DString TranslatorEnglish::trPublicMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 642 of file translator_en.h.

643 { return "Public Member Functions"; }

◆ trPublicSlots()

DString TranslatorEnglish::trPublicSlots ( )

inlineoverridevirtual

Implements Translator.

Definition at line 644 of file translator_en.h.

645 { return "Public Slots"; }

◆ trPublicTypes()

DString TranslatorEnglish::trPublicTypes ( )

inlineoverridevirtual

Implements Translator.

Definition at line 905 of file translator_en.h.

    {
      return "Public Types";
    }

◆ trReferencedBy()

DString TranslatorEnglish::trReferencedBy ( )

inlineoverridevirtual

Implements Translator.

Definition at line 968 of file translator_en.h.

    {
      return "Referenced by";
    }

◆ trReferenceManual()

DString TranslatorEnglish::trReferenceManual ( )

inlineoverridevirtual

This is used in LaTeX as the title of the document

Implements Translator.

Definition at line 434 of file translator_en.h.

435 { return "Reference Manual"; }

◆ trReferences()

DString TranslatorEnglish::trReferences ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1283 of file translator_en.h.

    {
      return "References";
    }

◆ trReimplementedFromList()

DString 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 706 of file translator_en.h.

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

References trWriteList().

◆ trReimplementedInList()

DString 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 714 of file translator_en.h.

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

References trWriteList().

◆ trRelatedFunctionDocumentation()

DString TranslatorEnglish::trRelatedFunctionDocumentation ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 597 of file translator_en.h.

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

◆ trRelatedFunctions()

DString TranslatorEnglish::trRelatedFunctions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 87 of file translator_en.h.

88 { return "Related Functions"; }

◆ trRelatedPages()

DString TranslatorEnglish::trRelatedPages ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 234 of file translator_en.h.

235 { return "Related Pages"; }

◆ trRelatedPagesDescription()

DString TranslatorEnglish::trRelatedPagesDescription ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 356 of file translator_en.h.

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

◆ trRelatedSubscript()

DString TranslatorEnglish::trRelatedSubscript ( )

inlineoverridevirtual

subscript for the related functions.

Implements Translator.

Definition at line 91 of file translator_en.h.

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

◆ trRelatedSymbolDocumentation()

DString 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 2340 of file translator_en.h.

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

◆ trRelatedSymbols()

DString 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 2325 of file translator_en.h.

2326 { return "Related Symbols"; }

◆ trRelatedSymbolsSubscript()

DString TranslatorEnglish::trRelatedSymbolsSubscript ( )

inlineoverridevirtual

subscript for the related symbols

Supersedes trRelatedSubscript

Implements Translator.

Definition at line 2332 of file translator_en.h.

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

◆ trRemarks()

DString TranslatorEnglish::trRemarks ( )

inlineoverridevirtual

Implements Translator.

Definition at line 972 of file translator_en.h.

    {
      return "Remarks";
    }

◆ trRequirementID()

DString TranslatorEnglish::trRequirementID ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2624 of file translator_en.h.

    {
      return "ID";
    }

Referenced by TranslatorAdapter_1_16_0::trRequirementID().

◆ trRequirements()

DString TranslatorEnglish::trRequirements ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2619 of file translator_en.h.

    {
      return "Requirements";
    }

Referenced by TranslatorAdapter_1_16_0::trRequirements().

◆ trReturns()

DString TranslatorEnglish::trReturns ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 548 of file translator_en.h.

549 { return "Returns"; }

◆ trReturnValues()

DString TranslatorEnglish::trReturnValues ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 790 of file translator_en.h.

791 { return "Return values"; }

◆ trRTFansicp()

DString 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 1183 of file translator_en.h.

    {
      return "1252";
    }

◆ trRTFCharSet()

DString 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 1192 of file translator_en.h.

    {
      return "0";
    }

◆ trRTFGeneralIndex()

DString TranslatorEnglish::trRTFGeneralIndex ( )

inlineoverridevirtual

Used as header RTF general index

Implements Translator.

Definition at line 1198 of file translator_en.h.

    {
      return "Index";
    }

◆ trRTFTableOfContents()

DString TranslatorEnglish::trRTFTableOfContents ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1315 of file translator_en.h.

    {
      return "Table of Contents";
    }

◆ trSatisfiedBy()

DString TranslatorEnglish::trSatisfiedBy ( const DString & list )

inlineoverridevirtual

Implements Translator.

Definition at line 2634 of file translator_en.h.

    {
      return "Satisfied by "+list+".";
    }

Referenced by TranslatorAdapter_1_16_0::trSatisfiedBy().

◆ trSatisfies()

DString TranslatorEnglish::trSatisfies ( bool singular )

inlineoverridevirtual

Implements Translator.

Definition at line 2629 of file translator_en.h.

    {
      return createNoun(true, singular, "Satisfies requirement", "s");
    }

References Translator::createNoun().

Referenced by TranslatorAdapter_1_16_0::trSatisfies().

◆ trSearch()

DString TranslatorEnglish::trSearch ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 242 of file translator_en.h.

243 { return "Search"; }

◆ trSearching()

DString TranslatorEnglish::trSearching ( )

inlineoverridevirtual

Message shown while searching

Implements Translator.

Definition at line 1749 of file translator_en.h.

    {
      return "Searching...";
    }

Referenced by TranslatorAdapter_1_6_0::trSearching().

◆ trSearchMatches()

DString 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 1447 of file translator_en.h.

    {
      return "Matches:";
    }

◆ trSearchResults()

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

DString TranslatorEnglish::trSearchResultsTitle ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1416 of file translator_en.h.

    {
      return "Search Results";
    }

◆ trSeeAlso()

DString TranslatorEnglish::trSeeAlso ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 552 of file translator_en.h.

553 { return "See also"; }

◆ trSequenceDocumentation()

DString TranslatorEnglish::trSequenceDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2125 of file translator_en.h.

    {
        return "Sequence Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trSequenceDocumentation().

◆ trSequences()

DString TranslatorEnglish::trSequences ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2121 of file translator_en.h.

    {
        return "Sequences";
    }

Referenced by TranslatorAdapter_1_8_15::trSequences().

◆ trServiceGeneratedFromFiles()

DString TranslatorEnglish::trServiceGeneratedFromFiles ( bool single )

inlineoverridevirtual

UNO IDL service page.

Implements Translator.

Definition at line 1977 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_4::trServiceGeneratedFromFiles().

◆ trServiceReference()

DString TranslatorEnglish::trServiceReference ( const DString & sName )

inlineoverridevirtual

UNO IDL service page title.

Implements Translator.

Definition at line 1963 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_4::trServiceReference().

◆ trServices()

DString TranslatorEnglish::trServices ( )

inlineoverridevirtual

old style UNO IDL services: inherited services

Implements Translator.

Definition at line 1948 of file translator_en.h.

1949 { return "Included Services"; }

Referenced by TranslatorAdapter_1_8_4::trServices().

◆ trSignals()

DString TranslatorEnglish::trSignals ( )

inlineoverridevirtual

Implements Translator.

Definition at line 646 of file translator_en.h.

647 { return "Signals"; }

◆ trSince()

DString TranslatorEnglish::trSince ( )

inlineoverridevirtual

Implements Translator.

Definition at line 985 of file translator_en.h.

    {
      return "Since";
    }

◆ trSingletonGeneratedFromFiles()

DString TranslatorEnglish::trSingletonGeneratedFromFiles ( bool single )

inlineoverridevirtual

UNO IDL singleton page.

Implements Translator.

Definition at line 1986 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_4::trSingletonGeneratedFromFiles().

◆ trSingletonReference()

DString TranslatorEnglish::trSingletonReference ( const DString & sName )

inlineoverridevirtual

UNO IDL singleton page title.

Implements Translator.

Definition at line 1970 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_4::trSingletonReference().

◆ trSliceInterfaces()

DString TranslatorEnglish::trSliceInterfaces ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2137 of file translator_en.h.

    {
        return "Interfaces";
    }

Referenced by TranslatorAdapter_1_8_15::trSliceInterfaces().

◆ trSourceFile()

DString TranslatorEnglish::trSourceFile ( const DString & filename )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1458 of file translator_en.h.

    {
      return filename + " Source File";
    }

◆ trStaticPackageAttribs()

DString TranslatorEnglish::trStaticPackageAttribs ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1387 of file translator_en.h.

    {
      return "Static Package Attributes";
    }

◆ trStaticPackageFunctions()

DString TranslatorEnglish::trStaticPackageFunctions ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 1373 of file translator_en.h.

    {
      return "Static Package Functions";
    }

◆ trStaticPrivateAttribs()

DString TranslatorEnglish::trStaticPrivateAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 944 of file translator_en.h.

    {
      return "Static Private Attributes";
    }

◆ trStaticPrivateMembers()

DString TranslatorEnglish::trStaticPrivateMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 660 of file translator_en.h.

661 { return "Static Private Member Functions"; }

◆ trStaticProtectedAttribs()

DString TranslatorEnglish::trStaticProtectedAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 932 of file translator_en.h.

    {
      return "Static Protected Attributes";
    }

◆ trStaticProtectedMembers()

DString TranslatorEnglish::trStaticProtectedMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 654 of file translator_en.h.

655 { return "Static Protected Member Functions"; }

◆ trStaticPublicAttribs()

DString TranslatorEnglish::trStaticPublicAttribs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 920 of file translator_en.h.

    {
      return "Static Public Attributes";
    }

◆ trStaticPublicMembers()

DString TranslatorEnglish::trStaticPublicMembers ( )

inlineoverridevirtual

Implements Translator.

Definition at line 648 of file translator_en.h.

649 { return "Static Public Member Functions"; }

◆ trStructDocumentation()

DString TranslatorEnglish::trStructDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2181 of file translator_en.h.

    {
        return "Struct Documentation";
    }

Referenced by TranslatorAdapter_1_8_15::trStructDocumentation().

◆ trStructIndex()

DString TranslatorEnglish::trStructIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2169 of file translator_en.h.

    {
        return "Struct Index";
    }

Referenced by TranslatorAdapter_1_8_15::trStructIndex().

◆ trStructList()

DString TranslatorEnglish::trStructList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2173 of file translator_en.h.

    {
        return "Struct List";
    }

Referenced by TranslatorAdapter_1_8_15::trStructList().

◆ trStructListDescription()

DString TranslatorEnglish::trStructListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2177 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_8_15::trStructListDescription().

◆ trStructs()

DString TranslatorEnglish::trStructs ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2165 of file translator_en.h.

    {
        return "Structs";
    }

Referenced by TranslatorAdapter_1_8_15::trStructs().

◆ trSubprogram()

DString 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 1715 of file translator_en.h.

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

References Translator::createNoun().

Referenced by TranslatorAdapter_1_6_0::trSubprogram().

◆ trSubprogramDocumentation()

DString 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 1591 of file translator_en.h.

1592 { return "Function/Subroutine Documentation"; }

Referenced by TranslatorAdapter_1_6_0::trSubprogramDocumentation().

◆ trSubprograms()

DString 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 1585 of file translator_en.h.

1586 { return "Functions/Subroutines"; }

Referenced by TranslatorAdapter_1_6_0::trSubprograms().

◆ trTemplateParameters()

DString TranslatorEnglish::trTemplateParameters ( )

inlineoverridevirtual

Section header for list of template parameters

Implements Translator.

Definition at line 1855 of file translator_en.h.

1856 { return "Template Parameters"; }

Referenced by TranslatorAdapter_1_8_0::trTemplateParameters().

◆ trTest()

DString TranslatorEnglish::trTest ( )

inlineoverridevirtual

Used as a marker that is put before a test item

Implements Translator.

Definition at line 1077 of file translator_en.h.

    {
      return "Test";
    }

◆ trTestList()

DString TranslatorEnglish::trTestList ( )

inlineoverridevirtual

Used as the header of the test list

Implements Translator.

Definition at line 1082 of file translator_en.h.

    {
      return "Test List";
    }

◆ trThisIsTheListOfAllMembers()

DString TranslatorEnglish::trThisIsTheListOfAllMembers ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 149 of file translator_en.h.

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

◆ trTodo()

DString TranslatorEnglish::trTodo ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 954 of file translator_en.h.

    {
      return "Todo";
    }

◆ trTodoList()

DString TranslatorEnglish::trTodoList ( )

inlineoverridevirtual

Used as the header of the todo list

Implements Translator.

Definition at line 959 of file translator_en.h.

    {
      return "Todo List";
    }

◆ trTopicDocumentation()

DString TranslatorEnglish::trTopicDocumentation ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2546 of file translator_en.h.

2547 { return "Topic Documentation"; }

Referenced by TranslatorAdapter_1_9_8::trTopicDocumentation().

◆ trTopicIndex()

DString TranslatorEnglish::trTopicIndex ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2550 of file translator_en.h.

2551 { return "Topic Index"; }

Referenced by TranslatorAdapter_1_9_8::trTopicIndex().

◆ trTopicList()

DString TranslatorEnglish::trTopicList ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2548 of file translator_en.h.

2549 { return "Topic List"; }

Referenced by TranslatorAdapter_1_9_8::trTopicList().

◆ trTopicListDescription()

DString TranslatorEnglish::trTopicListDescription ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2552 of file translator_en.h.

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

Referenced by TranslatorAdapter_1_9_8::trTopicListDescription().

◆ trTopics()

DString TranslatorEnglish::trTopics ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2544 of file translator_en.h.

2545 { return "Topics"; }

Referenced by TranslatorAdapter_1_9_8::trTopics().

◆ trType()

DString 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 1706 of file translator_en.h.

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

References Translator::createNoun().

Referenced by trCompoundType(), and TranslatorAdapter_1_6_0::trType().

◆ trTypeConstraints()

DString TranslatorEnglish::trTypeConstraints ( )

inlineoverridevirtual

C# Type Constraint list

Implements Translator.

Definition at line 1721 of file translator_en.h.

    {
      return "Type Constraints";
    }

Referenced by TranslatorAdapter_1_6_0::trTypeConstraints().

◆ trTypedefDocumentation()

DString 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 482 of file translator_en.h.

483 { return "Typedef Documentation"; }

◆ trTypedefs()

DString 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 446 of file translator_en.h.

447 { return "Typedefs"; }

◆ trTypeDocumentation()

DString 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 1579 of file translator_en.h.

1580 { return "Data Type Documentation"; }

Referenced by TranslatorAdapter_1_6_0::trTypeDocumentation().

◆ trUnsatisfiedRequirements()

DString TranslatorEnglish::trUnsatisfiedRequirements ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2638 of file translator_en.h.

    {
      return "Unsatisfied Requirements";
    }

Referenced by TranslatorAdapter_1_16_0::trUnsatisfiedRequirements().

◆ trUnsatisfiedRequirementsText()

DString TranslatorEnglish::trUnsatisfiedRequirementsText	(	bool	singular,
		const DString &	list )

inlineoverridevirtual

Implements Translator.

Definition at line 2642 of file translator_en.h.

    {
      return singular ?
        "The requirement "+list+" does not have a 'satisfies' relation." :
        "The requirements "+list+" do not have a 'satisfies' relation.";
    }

Referenced by TranslatorAdapter_1_16_0::trUnsatisfiedRequirementsText().

◆ trUnverifiedRequirements()

DString TranslatorEnglish::trUnverifiedRequirements ( )

inlineoverridevirtual

Implements Translator.

Definition at line 2658 of file translator_en.h.

    {
      return "Unverified Requirements";
    }

Referenced by TranslatorAdapter_1_16_0::trUnverifiedRequirements().

◆ trUnverifiedRequirementsText()

DString TranslatorEnglish::trUnverifiedRequirementsText	(	bool	singular,
		const DString &	list )

inlineoverridevirtual

Implements Translator.

Definition at line 2662 of file translator_en.h.

    {
      return singular ?
        "The requirement "+list+" does not have a 'verifies' relation." :
        "The requirements "+list+" do not have a 'verifies' relation.";
    }

Referenced by TranslatorAdapter_1_16_0::trUnverifiedRequirementsText().

◆ trVariableDocumentation()

DString 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 500 of file translator_en.h.

501 { return "Variable Documentation"; }

◆ trVariables()

DString 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 464 of file translator_en.h.

465 { return "Variables"; }

◆ trVerifiedBy()

DString TranslatorEnglish::trVerifiedBy ( const DString & list )

inlineoverridevirtual

Implements Translator.

Definition at line 2654 of file translator_en.h.

    {
      return "Verified by "+list+".";
    }

Referenced by TranslatorAdapter_1_16_0::trVerifiedBy().

◆ trVerifies()

DString TranslatorEnglish::trVerifies ( bool singular )

inlineoverridevirtual

Implements Translator.

Definition at line 2649 of file translator_en.h.

    {
      return createNoun(true, singular, "Verifies requirement", "s");
    }

References Translator::createNoun().

Referenced by TranslatorAdapter_1_16_0::trVerifies().

◆ trVersion()

DString TranslatorEnglish::trVersion ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 540 of file translator_en.h.

541 { return "Version"; }

◆ trVhdlType()

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

inlineoverridevirtual

VHDL type.

Implements Translator.

Definition at line 2024 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.

Referenced by TranslatorAdapter_1_8_15::trVhdlType().

◆ trWarning()

DString TranslatorEnglish::trWarning ( )

inlineoverridevirtual

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

Implements Translator.

Definition at line 536 of file translator_en.h.

537 { return "Warning"; }

◆ trWriteList()

DString 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 666 of file translator_en.h.

    {
      DString 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