#include <translator_en.h>

Inheritance diagram for TranslatorEnglish:

Public Member Functions
virtual QCString	idLanguage ()

virtual QCString	latexLanguageSupportCommand ()

virtual QCString	trRelatedFunctions ()

virtual QCString	trRelatedSubscript ()

virtual QCString	trDetailedDescription ()

virtual QCString	trMemberTypedefDocumentation ()

virtual QCString	trMemberEnumerationDocumentation ()

virtual QCString	trMemberFunctionDocumentation ()

virtual QCString	trMemberDataDocumentation ()

virtual QCString	trMore ()

virtual QCString	trListOfAllMembers ()

virtual QCString	trMemberList ()

virtual QCString	trThisIsTheListOfAllMembers ()

virtual QCString	trIncludingInheritedMembers ()

virtual QCString	trGeneratedAutomatically (const char *s)

virtual QCString	trEnumName ()

virtual QCString	trEnumValue ()

virtual QCString	trDefinedIn ()

virtual QCString	trModules ()

virtual QCString	trClassHierarchy ()

virtual QCString	trCompoundList ()

virtual QCString	trFileList ()

virtual QCString	trCompoundMembers ()

virtual QCString	trFileMembers ()

virtual QCString	trRelatedPages ()

virtual QCString	trExamples ()

virtual QCString	trSearch ()

virtual QCString	trClassHierarchyDescription ()

virtual QCString	trFileListDescription (bool extractAll)

virtual QCString	trCompoundListDescription ()

virtual QCString	trCompoundMembersDescription (bool extractAll)

virtual QCString	trFileMembersDescription (bool extractAll)

virtual QCString	trExamplesDescription ()

virtual QCString	trRelatedPagesDescription ()

virtual QCString	trModulesDescription ()

virtual QCString	trDocumentation ()

virtual QCString	trModuleIndex ()

virtual QCString	trHierarchicalIndex ()

virtual QCString	trCompoundIndex ()

virtual QCString	trFileIndex ()

virtual QCString	trModuleDocumentation ()

virtual QCString	trClassDocumentation ()

virtual QCString	trFileDocumentation ()

virtual QCString	trExampleDocumentation ()

virtual QCString	trPageDocumentation ()

virtual QCString	trReferenceManual ()

virtual QCString	trDefines ()

virtual QCString	trTypedefs ()

virtual QCString	trEnumerations ()

virtual QCString	trFunctions ()

virtual QCString	trVariables ()

virtual QCString	trEnumerationValues ()

virtual QCString	trDefineDocumentation ()

virtual QCString	trTypedefDocumentation ()

virtual QCString	trEnumerationTypeDocumentation ()

virtual QCString	trFunctionDocumentation ()

virtual QCString	trVariableDocumentation ()

virtual QCString	trCompounds ()

virtual QCString	trGeneratedAt (const char date, const char projName)

virtual QCString	trClassDiagram (const char *clName)

virtual QCString	trForInternalUseOnly ()

virtual QCString	trWarning ()

virtual QCString	trVersion ()

virtual QCString	trDate ()

virtual QCString	trReturns ()

virtual QCString	trSeeAlso ()

virtual QCString	trParameters ()

virtual QCString	trExceptions ()

virtual QCString	trGeneratedBy ()

virtual QCString	trNamespaceList ()

virtual QCString	trNamespaceListDescription (bool extractAll)

virtual QCString	trFriends ()

virtual QCString	trRelatedFunctionDocumentation ()

virtual QCString	trCompoundReference (const char *clName, ClassDef::CompoundType compType, bool isTemplate)

virtual QCString	trFileReference (const char *fileName)

virtual QCString	trNamespaceReference (const char *namespaceName)

virtual QCString	trPublicMembers ()

virtual QCString	trPublicSlots ()

virtual QCString	trSignals ()

virtual QCString	trStaticPublicMembers ()

virtual QCString	trProtectedMembers ()

virtual QCString	trProtectedSlots ()

virtual QCString	trStaticProtectedMembers ()

virtual QCString	trPrivateMembers ()

virtual QCString	trPrivateSlots ()

virtual QCString	trStaticPrivateMembers ()

virtual QCString	trWriteList (int numEntries)

virtual QCString	trInheritsList (int numEntries)

virtual QCString	trInheritedByList (int numEntries)

virtual QCString	trReimplementedFromList (int numEntries)

virtual QCString	trReimplementedInList (int numEntries)

virtual QCString	trNamespaceMembers ()

virtual QCString	trNamespaceMemberDescription (bool extractAll)

virtual QCString	trNamespaceIndex ()

virtual QCString	trNamespaceDocumentation ()

virtual QCString	trNamespaces ()

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

virtual QCString	trReturnValues ()

virtual QCString	trMainPage ()

virtual QCString	trPageAbbreviation ()

virtual QCString	trDefinedAtLineInSourceFile ()

virtual QCString	trDefinedInSourceFile ()

virtual QCString	trDeprecated ()

virtual QCString	trCollaborationDiagram (const char *clName)

virtual QCString	trInclDepGraph (const char *fName)

virtual QCString	trConstructorDocumentation ()

virtual QCString	trGotoSourceCode ()

virtual QCString	trGotoDocumentation ()

virtual QCString	trPrecondition ()

virtual QCString	trPostcondition ()

virtual QCString	trInvariant ()

virtual QCString	trInitialValue ()

virtual QCString	trCode ()

virtual QCString	trGraphicalHierarchy ()

virtual QCString	trGotoGraphicalHierarchy ()

virtual QCString	trGotoTextualHierarchy ()

virtual QCString	trPageIndex ()

virtual QCString	trNote ()

virtual QCString	trPublicTypes ()

virtual QCString	trPublicAttribs ()

virtual QCString	trStaticPublicAttribs ()

virtual QCString	trProtectedTypes ()

virtual QCString	trProtectedAttribs ()

virtual QCString	trStaticProtectedAttribs ()

virtual QCString	trPrivateTypes ()

virtual QCString	trPrivateAttribs ()

virtual QCString	trStaticPrivateAttribs ()

virtual QCString	trTodo ()

virtual QCString	trTodoList ()

virtual QCString	trReferencedBy ()

virtual QCString	trRemarks ()

virtual QCString	trAttention ()

virtual QCString	trInclByDepGraph ()

virtual QCString	trSince ()

virtual QCString	trLegendTitle ()

virtual QCString	trLegendDocs ()

virtual QCString	trLegend ()

virtual QCString	trTest ()

virtual QCString	trTestList ()

virtual QCString	trProperties ()

virtual QCString	trPropertyDocumentation ()

virtual QCString	trClasses ()

virtual QCString	trPackage (const char *name)

virtual QCString	trPackageList ()

virtual QCString	trPackageListDescription ()

virtual QCString	trPackages ()

virtual QCString	trDefineValue ()

virtual QCString	trBug ()

virtual QCString	trBugList ()

virtual QCString	trRTFansicp ()

virtual QCString	trRTFCharSet ()

virtual QCString	trRTFGeneralIndex ()

virtual QCString	trClass (bool first_capital, bool singular)

virtual QCString	trFile (bool first_capital, bool singular)

virtual QCString	trNamespace (bool first_capital, bool singular)

virtual QCString	trGroup (bool first_capital, bool singular)

virtual QCString	trPage (bool first_capital, bool singular)

virtual QCString	trMember (bool first_capital, bool singular)

virtual QCString	trGlobal (bool first_capital, bool singular)

virtual QCString	trAuthor (bool first_capital, bool singular)

virtual QCString	trReferences ()

virtual QCString	trImplementedFromList (int numEntries)

virtual QCString	trImplementedInList (int numEntries)

virtual QCString	trRTFTableOfContents ()

virtual QCString	trDeprecatedList ()

virtual QCString	trEvents ()

virtual QCString	trEventDocumentation ()

virtual QCString	trPackageTypes ()

virtual QCString	trPackageMembers ()

virtual QCString	trStaticPackageMembers ()

virtual QCString	trPackageAttribs ()

virtual QCString	trStaticPackageAttribs ()

virtual QCString	trAll ()

virtual QCString	trCallGraph ()

virtual QCString	trSearchResultsTitle ()

virtual QCString	trSearchResults (int numDocuments)

virtual QCString	trSearchMatches ()

virtual QCString	trSourceFile (QCString &filename)

virtual QCString	trDirIndex ()

virtual QCString	trDirDocumentation ()

virtual QCString	trDirectories ()

virtual QCString	trDirDescription ()

virtual QCString	trDirReference (const char *dirName)

virtual QCString	trDir (bool first_capital, bool singular)

virtual QCString	trOverloadText ()

virtual QCString	trCallerGraph ()

virtual QCString	trEnumerationValueDocumentation ()

virtual QCString	trMemberFunctionDocumentationFortran ()

virtual QCString	trCompoundListFortran ()

virtual QCString	trCompoundMembersFortran ()

virtual QCString	trCompoundListDescriptionFortran ()

virtual QCString	trCompoundMembersDescriptionFortran (bool extractAll)

virtual QCString	trCompoundIndexFortran ()

virtual QCString	trTypeDocumentation ()

virtual QCString	trSubprograms ()

virtual QCString	trSubprogramDocumentation ()

virtual QCString	trDataTypes ()

virtual QCString	trModulesList ()

virtual QCString	trModulesListDescription (bool extractAll)

virtual QCString	trCompoundReferenceFortran (const char *clName, ClassDef::CompoundType compType, bool isTemplate)

virtual QCString	trModuleReference (const char *namespaceName)

virtual QCString	trModulesMembers ()

virtual QCString	trModulesMemberDescription (bool extractAll)

virtual QCString	trModulesIndex ()

virtual QCString	trModule (bool first_capital, bool singular)

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

virtual QCString	trType (bool first_capital, bool singular)

virtual QCString	trSubprogram (bool first_capital, bool singular)

virtual QCString	trTypeConstraints ()

virtual QCString	trDirRelation (const char *name)

virtual QCString	trLoading ()

virtual QCString	trGlobalNamespace ()

virtual QCString	trSearching ()

virtual QCString	trNoMatches ()

virtual QCString	trFileIn (const char *name)

virtual QCString	trIncludesFileIn (const char *name)

virtual QCString	trDateTime (int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime)

virtual QCString	trCiteReferences ()

virtual QCString	trCopyright ()

virtual QCString	trDirDepGraph (const char *name)

virtual QCString	trDetailLevel ()

virtual QCString	trTemplateParameters ()

virtual QCString	trAndMore (const QCString &number)

virtual QCString	trEnumGeneratedFromFiles (bool single)

virtual QCString	trEnumReference (const char *name)

virtual QCString	trInheritedFrom (const char members, const char what)

virtual QCString	trAdditionalInheritedMembers ()

virtual QCString	trPanelSynchronisationTooltip (bool enable)

virtual QCString	trProvidedByCategory ()

virtual QCString	trExtendsClass ()

virtual QCString	trClassMethods ()

virtual QCString	trInstanceMethods ()

virtual QCString	trMethodDocumentation ()

virtual QCString	trDesignOverview ()

virtual QCString	trInterfaces ()

virtual QCString	trServices ()

virtual QCString	trConstantGroups ()

virtual QCString	trConstantGroupReference (const char *namespaceName)

virtual QCString	trServiceReference (const char *sName)

virtual QCString	trSingletonReference (const char *sName)

virtual QCString	trServiceGeneratedFromFiles (bool single)

virtual QCString	trSingletonGeneratedFromFiles (bool single)

Public Member Functions inherited from Translator
virtual QCString	updateNeededMessage ()

virtual	~Translator ()

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) 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 occasionaly to adapter classes when the Translator class changes the interface, or back to the Translator class (by the local maintainer) when the localized translator is made up-to-date again.

Definition at line 43 of file translator_en.h.

Member Function Documentation

virtual QCString TranslatorEnglish::idLanguage ( )

inlinevirtual

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

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 55 of file translator_en.h.

56 { return "english"; }

virtual QCString TranslatorEnglish::latexLanguageSupportCommand ( )

inlinevirtual

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

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

or

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

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

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 72 of file translator_en.h.

     {
       return "";
     }

virtual QCString TranslatorEnglish::trAdditionalInheritedMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 1873 of file translator_en.h.

1874 { return "Additional Inherited Members"; }

virtual QCString TranslatorEnglish::trAll ( )

inlinevirtual

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

     {
       return "All";
     }

virtual QCString TranslatorEnglish::trAndMore ( const QCString & number )

inlinevirtual

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

Implements Translator.

Definition at line 1851 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trAttention ( )

inlinevirtual

Implements Translator.

Definition at line 956 of file translator_en.h.

     {
       return "Attention";
     }

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

inlinevirtual

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

Implements Translator.

Definition at line 1271 of file translator_en.h.

     {
       QCString result((first_capital ? "Author" : "author"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trBug ( )

inlinevirtual

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

Implements Translator.

Definition at line 1129 of file translator_en.h.

     {
       return "Bug";
     }

virtual QCString TranslatorEnglish::trBugList ( )

inlinevirtual

Used as the header of the bug list

Implements Translator.

Definition at line 1134 of file translator_en.h.

     {
       return "Bug List";
     }

virtual QCString TranslatorEnglish::trCallerGraph ( )

inlinevirtual

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

Implements Translator.

Definition at line 1525 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCallGraph ( )

inlinevirtual

Put in front of the call graph for a function.

Implements Translator.

Definition at line 1401 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCiteReferences ( )

inlinevirtual

Header for the page with bibliographic citations

Implements Translator.

Definition at line 1827 of file translator_en.h.

1828 { return "Bibliography"; }

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

inlinevirtual

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

     {
       QCString result((first_capital ? "Class" : "class"));
       if (!singular)  result+="es";
       return result;
     }

virtual QCString TranslatorEnglish::trClassDiagram ( const char * clName )

inlinevirtual

this text is put before a class diagram

Implements Translator.

Definition at line 506 of file translator_en.h.

     {
       return (QCString)"Inheritance diagram for "+clName+":";
     }

virtual QCString TranslatorEnglish::trClassDocumentation ( )

inlinevirtual

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

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

virtual QCString TranslatorEnglish::trClasses ( )

inlinevirtual

Used for Java classes in the summary section of Java packages

Implements Translator.

Definition at line 1087 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trClassHierarchy ( )

inlinevirtual

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

Implements Translator.

Definition at line 167 of file translator_en.h.

168 { return "Class Hierarchy"; }

virtual QCString TranslatorEnglish::trClassHierarchyDescription ( )

inlinevirtual

This is an introduction to the class hierarchy.

Implements Translator.

Definition at line 226 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trClassMethods ( )

inlinevirtual

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

     {
       return "Class Methods";
     }

virtual QCString TranslatorEnglish::trCode ( )

inlinevirtual

Text used the source code in the file index

Implements Translator.

Definition at line 856 of file translator_en.h.

     {
       return "code";
     }

virtual QCString TranslatorEnglish::trCollaborationDiagram ( const char * clName )

inlinevirtual

this text is put before a collaboration diagram

Implements Translator.

Definition at line 811 of file translator_en.h.

     {
       return (QCString)"Collaboration diagram for "+clName+":";
     }

virtual QCString TranslatorEnglish::trCompoundIndex ( )

inlinevirtual

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

Implements Translator.

Definition at line 352 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCompoundIndexFortran ( )

inlinevirtual

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

Implements Translator.

Definition at line 1580 of file translator_en.h.

1581 { return "Data Type Index"; }

virtual QCString TranslatorEnglish::trCompoundList ( )

inlinevirtual

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

Implements Translator.

Definition at line 171 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCompoundListDescription ( )

inlinevirtual

This is an introduction to the annotated compound list.

Implements Translator.

Definition at line 241 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCompoundListDescriptionFortran ( )

inlinevirtual

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

Implements Translator.

Definition at line 1553 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCompoundListFortran ( )

inlinevirtual

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

Implements Translator.

Definition at line 1545 of file translator_en.h.

1546 { return "Data Types List"; }

virtual QCString TranslatorEnglish::trCompoundMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 188 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCompoundMembersDescription ( bool extractAll )

inlinevirtual

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

Implements Translator.

Definition at line 256 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCompoundMembersDescriptionFortran ( bool extractAll )

inlinevirtual

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

Implements Translator.

Definition at line 1557 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trCompoundMembersFortran ( )

inlinevirtual

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

Implements Translator.

Definition at line 1549 of file translator_en.h.

1550 { return "Data Fields"; }

virtual QCString TranslatorEnglish::trCompoundReference	(	const char *	clName,
		ClassDef::CompoundType	compType,
		bool	isTemplate
	)

inlinevirtual

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

Implements Translator.

Definition at line 585 of file translator_en.h.

     {
       QCString result=(QCString)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;
     }

virtual QCString TranslatorEnglish::trCompoundReferenceFortran	(	const char *	clName,
		ClassDef::CompoundType	compType,
		bool	isTemplate
	)

inlinevirtual

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

Implements Translator.

Definition at line 1621 of file translator_en.h.

     {
       QCString result=(QCString)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;
     }

virtual QCString TranslatorEnglish::trCompounds ( )

inlinevirtual

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

Implements Translator.

Definition at line 482 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trConstantGroupReference ( const char * namespaceName )

inlinevirtual

UNO IDL constant groups

Implements Translator.

Definition at line 1956 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trConstantGroups ( )

inlinevirtual

UNO IDL constant groups

Implements Translator.

Definition at line 1952 of file translator_en.h.

1953 { return "Constant Groups"; }

virtual QCString TranslatorEnglish::trConstructorDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 821 of file translator_en.h.

     {
       return "Constructor & Destructor Documentation";
     }

virtual QCString TranslatorEnglish::trCopyright ( )

inlinevirtual

Text for copyright paragraph

Implements Translator.

Definition at line 1831 of file translator_en.h.

1832 { return "Copyright"; }

virtual QCString TranslatorEnglish::trDataTypes ( )

inlinevirtual

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

1605 { return "Data Types"; }

virtual QCString TranslatorEnglish::trDate ( )

inlinevirtual

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

Implements Translator.

Definition at line 524 of file translator_en.h.

525 { return "Date"; }

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

inlinevirtual

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

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

virtual QCString TranslatorEnglish::trDefinedAtLineInSourceFile ( )

inlinevirtual

Implements Translator.

Definition at line 788 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trDefinedIn ( )

inlinevirtual

put after an undocumented member in the list of all members

Implements Translator.

Definition at line 155 of file translator_en.h.

156 { return "defined in"; }

virtual QCString TranslatorEnglish::trDefinedInSourceFile ( )

inlinevirtual

Implements Translator.

Definition at line 792 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trDefineDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 452 of file translator_en.h.

453 { return "Macro Definition Documentation"; }

virtual QCString TranslatorEnglish::trDefines ( )

inlinevirtual

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

Implements Translator.

Definition at line 416 of file translator_en.h.

417 { return "Macros"; }

virtual QCString TranslatorEnglish::trDefineValue ( )

inlinevirtual

Text shown before a multi-line define

Implements Translator.

Definition at line 1119 of file translator_en.h.

     {
       return "Value:";
     }

virtual QCString TranslatorEnglish::trDeprecated ( )

inlinevirtual

Implements Translator.

Definition at line 801 of file translator_en.h.

     {
       return "Deprecated";
     }

virtual QCString TranslatorEnglish::trDeprecatedList ( )

inlinevirtual

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

Implements Translator.

Definition at line 1328 of file translator_en.h.

     {
       return "Deprecated List";
     }

virtual QCString TranslatorEnglish::trDesignOverview ( )

inlinevirtual

Used as the title of the design overview picture created for the VHDL output.

Implements Translator.

Definition at line 1934 of file translator_en.h.

     {
       return "Design Overview";
     }

virtual QCString TranslatorEnglish::trDetailedDescription ( )

inlinevirtual

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

Implements Translator.

Definition at line 88 of file translator_en.h.

89 { return "Detailed Description"; }

virtual QCString TranslatorEnglish::trDetailLevel ( )

inlinevirtual

Detail level selector shown for hierarchical indices

Implements Translator.

Definition at line 1843 of file translator_en.h.

1844 { return "detail level"; }

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

inlinevirtual

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

Implements Translator.

Definition at line 1499 of file translator_en.h.

     {
       QCString result((first_capital ? "Director" : "director"));
       if (singular) result+="y"; else result+="ies";
       return result;
     }

virtual QCString TranslatorEnglish::trDirDepGraph ( const char * name )

inlinevirtual

Header for the graph showing the directory dependencies

Implements Translator.

Definition at line 1835 of file translator_en.h.

1836 { return QCString("Directory dependency graph for ")+name+":"; }

name

static QCString name

Definition: declinfo.cpp:673

QCString

Definition: qcstring.h:131

virtual QCString TranslatorEnglish::trDirDescription ( )

inlinevirtual

This returns a sentences that introduces the directory hierarchy. and the fact that it is sorted alphabetically per level

Implements Translator.

Definition at line 1485 of file translator_en.h.

     { return "This directory hierarchy is sorted roughly, "
              "but not completely, alphabetically:";
     }

virtual QCString TranslatorEnglish::trDirDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 1473 of file translator_en.h.

1474 { return "Directory Documentation"; }

virtual QCString TranslatorEnglish::trDirectories ( )

inlinevirtual

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

1480 { return "Directories"; }

virtual QCString TranslatorEnglish::trDirIndex ( )

inlinevirtual

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

Implements Translator.

Definition at line 1467 of file translator_en.h.

1468 { return "Directory Hierarchy"; }

virtual QCString TranslatorEnglish::trDirReference ( const char * dirName )

inlinevirtual

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

Implements Translator.

Definition at line 1493 of file translator_en.h.

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

result

static QCString result

Definition: fortranscanner.cpp:56614

QCString

Definition: qcstring.h:131

virtual QCString TranslatorEnglish::trDirRelation ( const char * name )

inlinevirtual

directory relation for name

Implements Translator.

Definition at line 1744 of file translator_en.h.

     {
       return QCString(name)+" Relation";
     }

virtual QCString TranslatorEnglish::trDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 334 of file translator_en.h.

335 { return "Documentation"; }

virtual QCString TranslatorEnglish::trEnumerations ( )

inlinevirtual

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

Implements Translator.

Definition at line 428 of file translator_en.h.

429 { return "Enumerations"; }

virtual QCString TranslatorEnglish::trEnumerationTypeDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 464 of file translator_en.h.

465 { return "Enumeration Type Documentation"; }

virtual QCString TranslatorEnglish::trEnumerationValueDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 1533 of file translator_en.h.

1534 { return "Enumerator Documentation"; }

virtual QCString TranslatorEnglish::trEnumerationValues ( )

inlinevirtual

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

Implements Translator.

Definition at line 446 of file translator_en.h.

447 { return "Enumerator"; }

virtual QCString TranslatorEnglish::trEnumGeneratedFromFiles ( bool single )

inlinevirtual

Used file list for a Java enum

Implements Translator.

Definition at line 1855 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trEnumName ( )

inlinevirtual

put after an enum name in the list of all members

Implements Translator.

Definition at line 147 of file translator_en.h.

148 { return "enum name"; }

virtual QCString TranslatorEnglish::trEnumReference ( const char * name )

inlinevirtual

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

Implements Translator.

Definition at line 1863 of file translator_en.h.

1864 { return QCString(name)+" Enum Reference"; }

name

static QCString name

Definition: declinfo.cpp:673

QCString

Definition: qcstring.h:131

virtual QCString TranslatorEnglish::trEnumValue ( )

inlinevirtual

put after an enum value in the list of all members

Implements Translator.

Definition at line 151 of file translator_en.h.

152 { return "enum value"; }

virtual QCString TranslatorEnglish::trEventDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 1345 of file translator_en.h.

     {
       return "Event Documentation";
     }

virtual QCString TranslatorEnglish::trEvents ( )

inlinevirtual

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

Implements Translator.

Definition at line 1340 of file translator_en.h.

     {
       return "Events";
     }

virtual QCString TranslatorEnglish::trExampleDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 400 of file translator_en.h.

401 { return "Example Documentation"; }

virtual QCString TranslatorEnglish::trExamples ( )

inlinevirtual

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

Implements Translator.

Definition at line 218 of file translator_en.h.

219 { return "Examples"; }

virtual QCString TranslatorEnglish::trExamplesDescription ( )

inlinevirtual

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

Implements Translator.

Definition at line 320 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trExceptions ( )

inlinevirtual

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

Implements Translator.

Definition at line 540 of file translator_en.h.

541 { return "Exceptions"; }

virtual QCString TranslatorEnglish::trExtendsClass ( )

inlinevirtual

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

     {
       return "Extends class @0.";
     }

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

inlinevirtual

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

     {
       QCString result((first_capital ? "File" : "file"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trFileDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 394 of file translator_en.h.

395 { return "File Documentation"; }

virtual QCString TranslatorEnglish::trFileIn ( const char * name )

inlinevirtual

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

     {
       return (QCString)"File in "+name;
     }

virtual QCString TranslatorEnglish::trFileIndex ( )

inlinevirtual

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

Implements Translator.

Definition at line 367 of file translator_en.h.

368 { return "File Index"; }

virtual QCString TranslatorEnglish::trFileList ( )

inlinevirtual

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

Implements Translator.

Definition at line 184 of file translator_en.h.

185 { return "File List"; }

virtual QCString TranslatorEnglish::trFileListDescription ( bool extractAll )

inlinevirtual

This is an introduction to the list with all files.

Implements Translator.

Definition at line 232 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trFileMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 201 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trFileMembersDescription ( bool extractAll )

inlinevirtual

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

Implements Translator.

Definition at line 298 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trFileReference ( const char * fileName )

inlinevirtual

used as the title of the HTML page of a file

Implements Translator.

Definition at line 607 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trForInternalUseOnly ( )

inlinevirtual

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

Implements Translator.

Definition at line 512 of file translator_en.h.

513 { return "For internal use only."; }

virtual QCString TranslatorEnglish::trFriends ( )

inlinevirtual

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

Implements Translator.

Definition at line 567 of file translator_en.h.

568 { return "Friends"; }

virtual QCString TranslatorEnglish::trFunctionDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 470 of file translator_en.h.

471 { return "Function Documentation"; }

virtual QCString TranslatorEnglish::trFunctions ( )

inlinevirtual

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

Implements Translator.

Definition at line 434 of file translator_en.h.

435 { return "Functions"; }

virtual QCString TranslatorEnglish::trGeneratedAt	(	const char *	date,
		const char *	projName
	)

inlinevirtual

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

Implements Translator.

Definition at line 497 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trGeneratedAutomatically ( const char * s )

inlinevirtual

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

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

virtual QCString TranslatorEnglish::trGeneratedBy ( )

inlinevirtual

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

Implements Translator.

Definition at line 544 of file translator_en.h.

545 { return "Generated by"; }

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

inlinevirtual

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

     { // single is true implies a single file
       QCString result=(QCString)"The documentation for this ";
       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+=" was generated from the following file";
       if (single) result+=":"; else result+="s:";
       return result;
     }

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

inlinevirtual

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

     {
       // single is true implies a single file
       QCString result=(QCString)"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;
     }

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

inlinevirtual

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

     {
       QCString result((first_capital ? "Global" : "global"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trGlobalNamespace ( )

inlinevirtual

Label used for search results in the global namespace

Implements Translator.

Definition at line 1756 of file translator_en.h.

     {
       return "Global Namespace";
     }

virtual QCString TranslatorEnglish::trGotoDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 831 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trGotoGraphicalHierarchy ( )

inlinevirtual

Implements Translator.

Definition at line 864 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trGotoSourceCode ( )

inlinevirtual

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

Implements Translator.

Definition at line 826 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trGotoTextualHierarchy ( )

inlinevirtual

Implements Translator.

Definition at line 868 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trGraphicalHierarchy ( )

inlinevirtual

Implements Translator.

Definition at line 860 of file translator_en.h.

     {
       return "Graphical Class Hierarchy";
     }

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

inlinevirtual

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.

     {
       QCString result((first_capital ? "Module" : "module"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trHierarchicalIndex ( )

inlinevirtual

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

Implements Translator.

Definition at line 346 of file translator_en.h.

347 { return "Hierarchical Index"; }

virtual QCString TranslatorEnglish::trImplementedFromList ( int numEntries )

inlinevirtual

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

Implements Translator.

Definition at line 1296 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trImplementedInList ( int numEntries )

inlinevirtual

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

Implements Translator.

Definition at line 1304 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trInclByDepGraph ( )

inlinevirtual

Implements Translator.

Definition at line 960 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trInclDepGraph ( const char * fName )

inlinevirtual

this text is put before an include dependency graph

Implements Translator.

Definition at line 816 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trIncludesFileIn ( const char * name )

inlinevirtual

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

     {
       return (QCString)"Includes file in "+name;
     }

virtual QCString TranslatorEnglish::trIncludingInheritedMembers ( )

inlinevirtual

this is the remainder of the sentence after the class name

Implements Translator.

Definition at line 133 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trInheritedByList ( int numEntries )

inlinevirtual

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

Implements Translator.

Definition at line 679 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trInheritedFrom	(	const char *	members,
		const char *	what
	)

inlinevirtual

Used for a section containing inherited members

Implements Translator.

Definition at line 1867 of file translator_en.h.

1868 { return QCString(members)+" inherited from "+what; }

QCString

Definition: qcstring.h:131

virtual QCString TranslatorEnglish::trInheritsList ( int numEntries )

inlinevirtual

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

Implements Translator.

Definition at line 671 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trInitialValue ( )

inlinevirtual

Text shown before a multi-line variable/enum initialization

Implements Translator.

Definition at line 851 of file translator_en.h.

     {
       return "Initial value:";
     }

virtual QCString TranslatorEnglish::trInstanceMethods ( )

inlinevirtual

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

     {
       return "Instance Methods";
     }

virtual QCString TranslatorEnglish::trInterfaces ( )

inlinevirtual

old style UNO IDL services: implemented interfaces

Implements Translator.

Definition at line 1944 of file translator_en.h.

1945 { return "Exported Interfaces"; }

virtual QCString TranslatorEnglish::trInvariant ( )

inlinevirtual

Text for the \invariant command

Implements Translator.

Definition at line 846 of file translator_en.h.

     {
       return "Invariant";
     }

virtual QCString TranslatorEnglish::trLegend ( )

inlinevirtual

text for the link to the legend page

Implements Translator.

Definition at line 1047 of file translator_en.h.

     {
       return "legend";
     }

virtual QCString TranslatorEnglish::trLegendDocs ( )

inlinevirtual

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 982 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 dark 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";
     }

virtual QCString TranslatorEnglish::trLegendTitle ( )

inlinevirtual

title of the graph legend page

Implements Translator.

Definition at line 975 of file translator_en.h.

     {
       return "Graph Legend";
     }

virtual QCString TranslatorEnglish::trListOfAllMembers ( )

inlinevirtual

put in the class documentation

Implements Translator.

Definition at line 121 of file translator_en.h.

122 { return "List of all members"; }

virtual QCString TranslatorEnglish::trLoading ( )

inlinevirtual

Loading message shown when loading search results

Implements Translator.

Definition at line 1750 of file translator_en.h.

     {
       return "Loading...";
     }

virtual QCString TranslatorEnglish::trMainPage ( )

inlinevirtual

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

Implements Translator.

Definition at line 775 of file translator_en.h.

776 { return "Main Page"; }

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

inlinevirtual

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

     {
       QCString result((first_capital ? "Member" : "member"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trMemberDataDocumentation ( )

inlinevirtual

header that is put before the list of member attributes.

Implements Translator.

Definition at line 104 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trMemberEnumerationDocumentation ( )

inlinevirtual

header that is put before the list of enumerations.

Implements Translator.

Definition at line 96 of file translator_en.h.

97 { return "Member Enumeration Documentation"; }

virtual QCString TranslatorEnglish::trMemberFunctionDocumentation ( )

inlinevirtual

header that is put before the list of member functions.

Implements Translator.

Definition at line 100 of file translator_en.h.

101 { return "Member Function Documentation"; }

virtual QCString TranslatorEnglish::trMemberFunctionDocumentationFortran ( )

inlinevirtual

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

Implements Translator.

Definition at line 1541 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trMemberList ( )

inlinevirtual

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

Implements Translator.

Definition at line 125 of file translator_en.h.

126 { return "Member List"; }

virtual QCString TranslatorEnglish::trMemberTypedefDocumentation ( )

inlinevirtual

header that is put before the list of typedefs.

Implements Translator.

Definition at line 92 of file translator_en.h.

93 { return "Member Typedef Documentation"; }

virtual QCString TranslatorEnglish::trMethodDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 1926 of file translator_en.h.

     {
       return "Method Documentation";
     }

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

inlinevirtual

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

     {
       QCString result((first_capital ? "Module" : "module"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trModuleDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 373 of file translator_en.h.

374 { return "Module Documentation"; }

virtual QCString TranslatorEnglish::trModuleIndex ( )

inlinevirtual

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

Implements Translator.

Definition at line 340 of file translator_en.h.

341 { return "Module Index"; }

virtual QCString TranslatorEnglish::trModuleReference ( const char * namespaceName )

inlinevirtual

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

Implements Translator.

Definition at line 1642 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trModules ( )

inlinevirtual

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

164 { return "Modules"; }

virtual QCString TranslatorEnglish::trModulesDescription ( )

inlinevirtual

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

Implements Translator.

Definition at line 328 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trModulesIndex ( )

inlinevirtual

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

Implements Translator.

Definition at line 1673 of file translator_en.h.

1674 { return "Modules Index"; }

virtual QCString TranslatorEnglish::trModulesList ( )

inlinevirtual

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

Implements Translator.

Definition at line 1608 of file translator_en.h.

1609 { return "Modules List"; }

virtual QCString TranslatorEnglish::trModulesListDescription ( bool extractAll )

inlinevirtual

used as an introduction to the modules list (Fortran)

Implements Translator.

Definition at line 1612 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trModulesMemberDescription ( bool extractAll )

inlinevirtual

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

Implements Translator.

Definition at line 1654 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trModulesMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 1650 of file translator_en.h.

1651 { return "Module Members"; }

virtual QCString TranslatorEnglish::trMore ( )

inlinevirtual

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

Implements Translator.

Definition at line 117 of file translator_en.h.

118 { return "More..."; }

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

inlinevirtual

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

     {
       QCString result((first_capital ? "Namespace" : "namespace"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trNamespaceDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 725 of file translator_en.h.

726 { return "Namespace Documentation"; }

virtual QCString TranslatorEnglish::trNamespaceIndex ( )

inlinevirtual

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

Implements Translator.

Definition at line 719 of file translator_en.h.

720 { return "Namespace Index"; }

virtual QCString TranslatorEnglish::trNamespaceList ( )

inlinevirtual

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

Implements Translator.

Definition at line 552 of file translator_en.h.

553 { return "Namespace List"; }

virtual QCString TranslatorEnglish::trNamespaceListDescription ( bool extractAll )

inlinevirtual

used as an introduction to the namespace list

Implements Translator.

Definition at line 556 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trNamespaceMemberDescription ( bool extractAll )

inlinevirtual

This is an introduction to the page with all namespace members

Implements Translator.

Definition at line 705 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trNamespaceMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 701 of file translator_en.h.

702 { return "Namespace Members"; }

virtual QCString TranslatorEnglish::trNamespaceReference ( const char * namespaceName )

inlinevirtual

used as the title of the HTML page of a namespace

Implements Translator.

Definition at line 615 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trNamespaces ( )

inlinevirtual

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

Implements Translator.

Definition at line 735 of file translator_en.h.

736 { return "Namespaces"; }

virtual QCString TranslatorEnglish::trNoMatches ( )

inlinevirtual

Text shown when no search results are found

Implements Translator.

Definition at line 1768 of file translator_en.h.

     {
       return "No Matches";
     }

virtual QCString TranslatorEnglish::trNote ( )

inlinevirtual

Implements Translator.

Definition at line 881 of file translator_en.h.

     {
       return "Note";
     }

virtual QCString TranslatorEnglish::trOverloadText ( )

inlinevirtual

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

Implements Translator.

Definition at line 1513 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.";
     }

virtual QCString TranslatorEnglish::trPackage ( const char * name )

inlinevirtual

Used as the title of a Java package

Implements Translator.

Definition at line 1099 of file translator_en.h.

     {
       return (QCString)"Package "+name;
     }

virtual QCString TranslatorEnglish::trPackageAttribs ( )

inlinevirtual

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

Implements Translator.

Definition at line 1377 of file translator_en.h.

     {
       return "Package Attributes";
     }

virtual QCString TranslatorEnglish::trPackageList ( )

inlinevirtual

Title of the package index page

Implements Translator.

Definition at line 1104 of file translator_en.h.

     {
       return "Package List";
     }

virtual QCString TranslatorEnglish::trPackageListDescription ( )

inlinevirtual

The description of the package index page

Implements Translator.

Definition at line 1109 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trPackageMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 1363 of file translator_en.h.

     {
       return "Package Functions";
     }

virtual QCString TranslatorEnglish::trPackages ( )

inlinevirtual

The link name in the Quick links header for each page

Implements Translator.

Definition at line 1114 of file translator_en.h.

     {
       return "Packages";
     }

virtual QCString TranslatorEnglish::trPackageTypes ( )

inlinevirtual

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

Implements Translator.

Definition at line 1356 of file translator_en.h.

     {
       return "Package Types";
     }

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

inlinevirtual

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

Implements Translator.

Definition at line 1236 of file translator_en.h.

     {
       QCString result((first_capital ? "Page" : "page"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trPageAbbreviation ( )

inlinevirtual

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

782 { return "p."; }

virtual QCString TranslatorEnglish::trPageDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 406 of file translator_en.h.

407 { return "Page Documentation"; }

virtual QCString TranslatorEnglish::trPageIndex ( )

inlinevirtual

Implements Translator.

Definition at line 872 of file translator_en.h.

     {
       return "Page Index";
     }

virtual QCString TranslatorEnglish::trPanelSynchronisationTooltip ( bool enable )

inlinevirtual

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

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

virtual QCString TranslatorEnglish::trParameters ( )

inlinevirtual

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

Implements Translator.

Definition at line 536 of file translator_en.h.

537 { return "Parameters"; }

virtual QCString TranslatorEnglish::trPostcondition ( )

inlinevirtual

Text for the \post command

Implements Translator.

Definition at line 841 of file translator_en.h.

     {
       return "Postcondition";
     }

virtual QCString TranslatorEnglish::trPrecondition ( )

inlinevirtual

Text for the \pre command

Implements Translator.

Definition at line 836 of file translator_en.h.

     {
       return "Precondition";
     }

virtual QCString TranslatorEnglish::trPrivateAttribs ( )

inlinevirtual

Implements Translator.

Definition at line 920 of file translator_en.h.

     {
       return "Private Attributes";
     }

virtual QCString TranslatorEnglish::trPrivateMembers ( )

inlinevirtual

Implements Translator.

Definition at line 636 of file translator_en.h.

637 { return "Private Member Functions"; }

virtual QCString TranslatorEnglish::trPrivateSlots ( )

inlinevirtual

Implements Translator.

Definition at line 638 of file translator_en.h.

639 { return "Private Slots"; }

virtual QCString TranslatorEnglish::trPrivateTypes ( )

inlinevirtual

Implements Translator.

Definition at line 916 of file translator_en.h.

     {
       return "Private Types";
     }

virtual QCString TranslatorEnglish::trProperties ( )

inlinevirtual

Used as a section header for IDL properties

Implements Translator.

Definition at line 1072 of file translator_en.h.

     {
       return "Properties";
     }

virtual QCString TranslatorEnglish::trPropertyDocumentation ( )

inlinevirtual

Used as a section header for IDL property documentation

Implements Translator.

Definition at line 1077 of file translator_en.h.

     {
       return "Property Documentation";
     }

virtual QCString TranslatorEnglish::trProtectedAttribs ( )

inlinevirtual

Implements Translator.

Definition at line 908 of file translator_en.h.

     {
       return "Protected Attributes";
     }

virtual QCString TranslatorEnglish::trProtectedMembers ( )

inlinevirtual

Implements Translator.

Definition at line 630 of file translator_en.h.

631 { return "Protected Member Functions"; }

virtual QCString TranslatorEnglish::trProtectedSlots ( )

inlinevirtual

Implements Translator.

Definition at line 632 of file translator_en.h.

633 { return "Protected Slots"; }

virtual QCString TranslatorEnglish::trProtectedTypes ( )

inlinevirtual

Implements Translator.

Definition at line 904 of file translator_en.h.

     {
       return "Protected Types";
     }

virtual QCString TranslatorEnglish::trProvidedByCategory ( )

inlinevirtual

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

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

virtual QCString TranslatorEnglish::trPublicAttribs ( )

inlinevirtual

Implements Translator.

Definition at line 889 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trPublicMembers ( )

inlinevirtual

Implements Translator.

Definition at line 622 of file translator_en.h.

623 { return "Public Member Functions"; }

virtual QCString TranslatorEnglish::trPublicSlots ( )

inlinevirtual

Implements Translator.

Definition at line 624 of file translator_en.h.

625 { return "Public Slots"; }

virtual QCString TranslatorEnglish::trPublicTypes ( )

inlinevirtual

Implements Translator.

Definition at line 885 of file translator_en.h.

     {
       return "Public Types";
     }

virtual QCString TranslatorEnglish::trReferencedBy ( )

inlinevirtual

Implements Translator.

Definition at line 948 of file translator_en.h.

     {
       return "Referenced by";
     }

virtual QCString TranslatorEnglish::trReferenceManual ( )

inlinevirtual

This is used in LaTeX as the title of the document

Implements Translator.

Definition at line 410 of file translator_en.h.

411 { return "Reference Manual"; }

virtual QCString TranslatorEnglish::trReferences ( )

inlinevirtual

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

Implements Translator.

Definition at line 1284 of file translator_en.h.

     {
       return "References";
     }

virtual QCString TranslatorEnglish::trReimplementedFromList ( int numEntries )

inlinevirtual

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

Implements Translator.

Definition at line 687 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trReimplementedInList ( int numEntries )

inlinevirtual

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

Implements Translator.

Definition at line 695 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trRelatedFunctionDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 577 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trRelatedFunctions ( )

inlinevirtual

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

Implements Translator.

Definition at line 80 of file translator_en.h.

81 { return "Related Functions"; }

virtual QCString TranslatorEnglish::trRelatedPages ( )

inlinevirtual

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

Implements Translator.

Definition at line 214 of file translator_en.h.

215 { return "Related Pages"; }

virtual QCString TranslatorEnglish::trRelatedPagesDescription ( )

inlinevirtual

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

Implements Translator.

Definition at line 324 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trRelatedSubscript ( )

inlinevirtual

subscript for the related functions.

Implements Translator.

Definition at line 84 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trRemarks ( )

inlinevirtual

Implements Translator.

Definition at line 952 of file translator_en.h.

     {
       return "Remarks";
     }

virtual QCString TranslatorEnglish::trReturns ( )

inlinevirtual

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

Implements Translator.

Definition at line 528 of file translator_en.h.

529 { return "Returns"; }

virtual QCString TranslatorEnglish::trReturnValues ( )

inlinevirtual

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

Implements Translator.

Definition at line 770 of file translator_en.h.

771 { return "Return values"; }

virtual QCString TranslatorEnglish::trRTFansicp ( )

inlinevirtual

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

     {
       return "1252";
     }

virtual QCString TranslatorEnglish::trRTFCharSet ( )

inlinevirtual

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

     {
       return "0";
     }

virtual QCString TranslatorEnglish::trRTFGeneralIndex ( )

inlinevirtual

Used as header RTF general index

Implements Translator.

Definition at line 1183 of file translator_en.h.

     {
       return "Index";
     }

virtual QCString TranslatorEnglish::trRTFTableOfContents ( )

inlinevirtual

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

Implements Translator.

Definition at line 1316 of file translator_en.h.

     {
       return "Table of Contents";
     }

virtual QCString TranslatorEnglish::trSearch ( )

inlinevirtual

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

Implements Translator.

Definition at line 222 of file translator_en.h.

223 { return "Search"; }

virtual QCString TranslatorEnglish::trSearching ( )

inlinevirtual

Message shown while searching

Implements Translator.

Definition at line 1762 of file translator_en.h.

     {
       return "Searching...";
     }

virtual QCString TranslatorEnglish::trSearchMatches ( )

inlinevirtual

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

     {
       return "Matches:";
     }

virtual QCString TranslatorEnglish::trSearchResults ( int numDocuments )

inlinevirtual

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 1425 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.";
       }
     }

virtual QCString TranslatorEnglish::trSearchResultsTitle ( )

inlinevirtual

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

Implements Translator.

Definition at line 1413 of file translator_en.h.

     {
       return "Search Results";
     }

virtual QCString TranslatorEnglish::trSeeAlso ( )

inlinevirtual

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

Implements Translator.

Definition at line 532 of file translator_en.h.

533 { return "See also"; }

virtual QCString TranslatorEnglish::trServiceGeneratedFromFiles ( bool single )

inlinevirtual

UNO IDL service page

Implements Translator.

Definition at line 1977 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trServiceReference ( const char * sName )

inlinevirtual

UNO IDL service page title

Implements Translator.

Definition at line 1963 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trServices ( )

inlinevirtual

old style UNO IDL services: inherited services

Implements Translator.

Definition at line 1948 of file translator_en.h.

1949 { return "Included Services"; }

virtual QCString TranslatorEnglish::trSignals ( )

inlinevirtual

Implements Translator.

Definition at line 626 of file translator_en.h.

627 { return "Signals"; }

virtual QCString TranslatorEnglish::trSince ( )

inlinevirtual

Implements Translator.

Definition at line 965 of file translator_en.h.

     {
       return "Since";
     }

virtual QCString TranslatorEnglish::trSingletonGeneratedFromFiles ( bool single )

inlinevirtual

UNO IDL singleton page

Implements Translator.

Definition at line 1986 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trSingletonReference ( const char * sName )

inlinevirtual

UNO IDL singleton page title

Implements Translator.

Definition at line 1970 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trSourceFile ( QCString & filename )

inlinevirtual

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

Implements Translator.

Definition at line 1455 of file translator_en.h.

     {
       return filename + " Source File";
     }

virtual QCString TranslatorEnglish::trStaticPackageAttribs ( )

inlinevirtual

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

Implements Translator.

Definition at line 1384 of file translator_en.h.

     {
       return "Static Package Attributes";
     }

virtual QCString TranslatorEnglish::trStaticPackageMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 1370 of file translator_en.h.

     {
       return "Static Package Functions";
     }

virtual QCString TranslatorEnglish::trStaticPrivateAttribs ( )

inlinevirtual

Implements Translator.

Definition at line 924 of file translator_en.h.

     {
       return "Static Private Attributes";
     }

virtual QCString TranslatorEnglish::trStaticPrivateMembers ( )

inlinevirtual

Implements Translator.

Definition at line 640 of file translator_en.h.

641 { return "Static Private Member Functions"; }

virtual QCString TranslatorEnglish::trStaticProtectedAttribs ( )

inlinevirtual

Implements Translator.

Definition at line 912 of file translator_en.h.

     {
       return "Static Protected Attributes";
     }

virtual QCString TranslatorEnglish::trStaticProtectedMembers ( )

inlinevirtual

Implements Translator.

Definition at line 634 of file translator_en.h.

635 { return "Static Protected Member Functions"; }

virtual QCString TranslatorEnglish::trStaticPublicAttribs ( )

inlinevirtual

Implements Translator.

Definition at line 900 of file translator_en.h.

     {
       return "Static Public Attributes";
     }

virtual QCString TranslatorEnglish::trStaticPublicMembers ( )

inlinevirtual

Implements Translator.

Definition at line 628 of file translator_en.h.

629 { return "Static Public Member Functions"; }

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

inlinevirtual

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

     {
       QCString result((first_capital ? "Subprogram" : "subprogram"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trSubprogramDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 1598 of file translator_en.h.

1599 { return "Function/Subroutine Documentation"; }

virtual QCString TranslatorEnglish::trSubprograms ( )

inlinevirtual

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

Implements Translator.

Definition at line 1592 of file translator_en.h.

1593 { return "Functions/Subroutines"; }

virtual QCString TranslatorEnglish::trTemplateParameters ( )

inlinevirtual

Section header for list of template parameters

Implements Translator.

Definition at line 1847 of file translator_en.h.

1848 { return "Template Parameters"; }

virtual QCString TranslatorEnglish::trTest ( )

inlinevirtual

Used as a marker that is put before a test item

Implements Translator.

Definition at line 1057 of file translator_en.h.

     {
       return "Test";
     }

virtual QCString TranslatorEnglish::trTestList ( )

inlinevirtual

Used as the header of the test list

Implements Translator.

Definition at line 1062 of file translator_en.h.

     {
       return "Test List";
     }

virtual QCString TranslatorEnglish::trThisIsTheListOfAllMembers ( )

inlinevirtual

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

Implements Translator.

Definition at line 129 of file translator_en.h.

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

virtual QCString TranslatorEnglish::trTodo ( )

inlinevirtual

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

Implements Translator.

Definition at line 934 of file translator_en.h.

     {
       return "Todo";
     }

virtual QCString TranslatorEnglish::trTodoList ( )

inlinevirtual

Used as the header of the todo list

Implements Translator.

Definition at line 939 of file translator_en.h.

     {
       return "Todo List";
     }

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

inlinevirtual

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.

     {
       QCString result((first_capital ? "Type" : "type"));
       if (!singular)  result+="s";
       return result;
     }

virtual QCString TranslatorEnglish::trTypeConstraints ( )

inlinevirtual

C# Type Constraint list

Implements Translator.

Definition at line 1734 of file translator_en.h.

     {
       return "Type Constraints";
     }

virtual QCString TranslatorEnglish::trTypedefDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 458 of file translator_en.h.

459 { return "Typedef Documentation"; }

virtual QCString TranslatorEnglish::trTypedefs ( )

inlinevirtual

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

Implements Translator.

Definition at line 422 of file translator_en.h.

423 { return "Typedefs"; }

virtual QCString TranslatorEnglish::trTypeDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 1586 of file translator_en.h.

1587 { return "Data Type Documentation"; }

virtual QCString TranslatorEnglish::trVariableDocumentation ( )

inlinevirtual

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

Implements Translator.

Definition at line 476 of file translator_en.h.

477 { return "Variable Documentation"; }

virtual QCString TranslatorEnglish::trVariables ( )

inlinevirtual

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

Implements Translator.

Definition at line 440 of file translator_en.h.

441 { return "Variables"; }

virtual QCString TranslatorEnglish::trVersion ( )

inlinevirtual

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

Implements Translator.

Definition at line 520 of file translator_en.h.

521 { return "Version"; }

virtual QCString TranslatorEnglish::trWarning ( )

inlinevirtual

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

Implements Translator.

Definition at line 516 of file translator_en.h.

517 { return "Warning"; }

virtual QCString TranslatorEnglish::trWriteList ( int numEntries )

inlinevirtual

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

     {
       QCString result;
       int i;
       // the inherits list contain `numEntries' classes
       for (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;
     }

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

doxygen-1.8.11/src/translator_en.h