summaryrefslogtreecommitdiffstats
path: root/src/translator_en.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/translator_en.h')
-rw-r--r--src/translator_en.h391
1 files changed, 192 insertions, 199 deletions
diff --git a/src/translator_en.h b/src/translator_en.h
index 1ab9921..0240b52 100644
--- a/src/translator_en.h
+++ b/src/translator_en.h
@@ -1,12 +1,12 @@
/******************************************************************************
*
- *
+ *
*
* Copyright (C) 1997-2013 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
@@ -18,7 +18,7 @@
#ifndef TRANSLATOR_EN_H
#define TRANSLATOR_EN_H
-/*!
+/*!
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
@@ -45,19 +45,19 @@ class TranslatorEnglish : public Translator
public:
// --- Language control methods -------------------
-
- /*! Used for identification of the language. The identification
- * should not be translated. It should be replaced by the name
+
+ /*! 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
+ * (e.g. "czech", "japanese", "russian", etc.). It should be equal to
* the identification used in language.cpp.
*/
virtual QCString idLanguage()
{ return "english"; }
-
- /*! Used to get the LaTeX command(s) for the language support.
+
+ /*! 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
+ * LaTeX to the desired language. For example
* <pre>"\\usepackage[german]{babel}\n"
* </pre>
* or
@@ -65,7 +65,7 @@ class TranslatorEnglish : public Translator
* "\\usepackage[latin2]{inputenc}\n"
* "\\usepackage[T1]{fontenc}\n"
* </pre>
- *
+ *
* The English LaTeX does not use such commands. Because of this
* the empty string is returned in this implementation.
*/
@@ -74,13 +74,6 @@ class TranslatorEnglish : public Translator
return "";
}
- /*! return the language charset. This will be used
- when transcoding the translatable strings in this file to UTF-8 */
- virtual QCString idLanguageCharset()
- {
- return "iso-8859-1";
- }
-
// --- Language translation methods -------------------
/*! used in the compound documentation before a list of related functions. */
@@ -98,30 +91,30 @@ class TranslatorEnglish : public Translator
/*! header that is put before the list of typedefs. */
virtual QCString trMemberTypedefDocumentation()
{ return "Member Typedef Documentation"; }
-
+
/*! header that is put before the list of enumerations. */
virtual QCString trMemberEnumerationDocumentation()
{ return "Member Enumeration Documentation"; }
-
+
/*! header that is put before the list of member functions. */
virtual QCString trMemberFunctionDocumentation()
{ return "Member Function Documentation"; }
-
+
/*! header that is put before the list of member attributes. */
virtual QCString trMemberDataDocumentation()
- {
+ {
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
- return "Field Documentation";
+ return "Field Documentation";
}
else
{
- return "Member Data Documentation";
+ return "Member Data Documentation";
}
}
/*! this is the text of a link put after brief descriptions. */
- virtual QCString trMore()
+ virtual QCString trMore()
{ return "More..."; }
/*! put in the class documentation */
@@ -139,81 +132,81 @@ class TranslatorEnglish : public Translator
/*! this is the remainder of the sentence after the class name */
virtual QCString trIncludingInheritedMembers()
{ return ", including all inherited members."; }
-
+
/*! this is put at the author sections at the bottom of man pages.
* parameter s is name of the project name.
*/
virtual QCString trGeneratedAutomatically(const char *s)
{ QCString result="Generated automatically by Doxygen";
if (s) result+=(QCString)" for "+s;
- result+=" from the source code.";
+ result+=" from the source code.";
return result;
}
/*! put after an enum name in the list of all members */
virtual QCString trEnumName()
{ return "enum name"; }
-
+
/*! put after an enum value in the list of all members */
virtual QCString trEnumValue()
{ return "enum value"; }
-
+
/*! put after an undocumented member in the list of all members */
virtual QCString trDefinedIn()
{ return "defined in"; }
// quick reference sections
- /*! This is put above each page as a link to the list of all groups of
+ /*! This is put above each page as a link to the list of all groups of
* compounds or files (see the \\group command).
*/
virtual QCString trModules()
{ return "Modules"; }
-
+
/*! This is put above each page as a link to the class hierarchy */
virtual QCString trClassHierarchy()
{ return "Class Hierarchy"; }
-
+
/*! This is put above each page as a link to the list of annotated classes */
virtual QCString trCompoundList()
- {
+ {
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
return "Data Structures";
}
else
{
- return "Class List";
+ return "Class List";
}
}
-
+
/*! This is put above each page as a link to the list of documented files */
virtual QCString trFileList()
{ return "File List"; }
/*! This is put above each page as a link to all members of compounds. */
virtual QCString trCompoundMembers()
- {
+ {
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
- return "Data Fields";
+ return "Data Fields";
}
else
{
- return "Class Members";
+ return "Class Members";
}
}
/*! This is put above each page as a link to all members of files. */
virtual QCString trFileMembers()
- {
+ {
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
- return "Globals";
+ return "Globals";
}
else
{
- return "File Members";
+ return "File Members";
}
}
@@ -246,16 +239,16 @@ class TranslatorEnglish : public Translator
/*! This is an introduction to the annotated compound list. */
virtual QCString trCompoundListDescription()
- {
-
+ {
+
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
- return "Here are the data structures with brief descriptions:";
+ return "Here are the data structures with brief descriptions:";
}
else
{
return "Here are the classes, structs, "
- "unions and interfaces with brief descriptions:";
+ "unions and interfaces with brief descriptions:";
}
}
@@ -276,7 +269,7 @@ class TranslatorEnglish : public Translator
result+="class members";
}
result+=" with links to ";
- if (!extractAll)
+ if (!extractAll)
{
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
@@ -287,7 +280,7 @@ class TranslatorEnglish : public Translator
result+="the class documentation for each member:";
}
}
- else
+ else
{
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
@@ -306,7 +299,7 @@ class TranslatorEnglish : public Translator
{
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";
@@ -316,9 +309,9 @@ class TranslatorEnglish : public Translator
result+="file members";
}
result+=" with links to ";
- if (extractAll)
+ if (extractAll)
result+="the files they belong to:";
- else
+ else
result+="the documentation:";
return result;
}
@@ -335,43 +328,43 @@ class TranslatorEnglish : public Translator
virtual QCString trModulesDescription()
{ return "Here is a list of all modules:"; }
- // index titles (the project name is prepended for these)
+ // index titles (the project name is prepended for these)
/*! This is used in HTML as the title of index.html. */
virtual QCString trDocumentation()
{ return "Documentation"; }
- /*! This is used in LaTeX as the title of the chapter with the
+ /*! This is used in LaTeX as the title of the chapter with the
* index of all groups.
*/
virtual QCString trModuleIndex()
{ return "Module Index"; }
- /*! This is used in LaTeX as the title of the chapter with the
+ /*! This is used in LaTeX as the title of the chapter with the
* class hierarchy.
*/
virtual QCString trHierarchicalIndex()
{ return "Hierarchical Index"; }
- /*! This is used in LaTeX as the title of the chapter with the
+ /*! This is used in LaTeX as the title of the chapter with the
* annotated compound index.
*/
virtual QCString trCompoundIndex()
{
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
- {
+ {
return "Data Structure Index";
}
else
{
- return "Class Index";
+ return "Class Index";
}
}
/*! This is used in LaTeX as the title of the chapter with the
* list of all files.
*/
- virtual QCString trFileIndex()
+ virtual QCString trFileIndex()
{ return "File Index"; }
/*! This is used in LaTeX as the title of the chapter containing
@@ -384,14 +377,14 @@ class TranslatorEnglish : public Translator
* the documentation of all classes, structs and unions.
*/
virtual QCString trClassDocumentation()
- {
+ {
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
- return "Data Structure Documentation";
+ return "Data Structure Documentation";
}
else
{
- return "Class Documentation";
+ return "Class Documentation";
}
}
@@ -416,105 +409,105 @@ class TranslatorEnglish : public Translator
/*! This is used in LaTeX as the title of the document */
virtual QCString trReferenceManual()
{ return "Reference Manual"; }
-
- /*! This is used in the documentation of a file as a header before the
+
+ /*! This is used in the documentation of a file as a header before the
* list of defines
*/
virtual QCString trDefines()
{ return "Macros"; }
- /*! This is used in the documentation of a file as a header before the
+ /*! This is used in the documentation of a file as a header before the
* list of function prototypes
*/
virtual QCString trFuncProtos()
{ return "Function Prototypes"; }
- /*! This is used in the documentation of a file as a header before the
+ /*! This is used in the documentation of a file as a header before the
* list of typedefs
*/
virtual QCString trTypedefs()
{ return "Typedefs"; }
- /*! This is used in the documentation of a file as a header before the
+ /*! This is used in the documentation of a file as a header before the
* list of enumerations
*/
virtual QCString trEnumerations()
{ return "Enumerations"; }
- /*! This is used in the documentation of a file as a header before the
+ /*! This is used in the documentation of a file as a header before the
* list of (global) functions
*/
virtual QCString trFunctions()
{ return "Functions"; }
- /*! This is used in the documentation of a file as a header before the
+ /*! This is used in the documentation of a file as a header before the
* list of (global) variables
*/
virtual QCString trVariables()
{ return "Variables"; }
- /*! This is used in the documentation of a file as a header before the
+ /*! This is used in the documentation of a file as a header before the
* list of (global) variables
*/
virtual QCString trEnumerationValues()
{ return "Enumerator"; }
-
+
/*! This is used in the documentation of a file before the list of
* documentation blocks for defines
*/
virtual QCString trDefineDocumentation()
{ return "Macro Definition Documentation"; }
- /*! This is used in the documentation of a file/namespace before the list
+ /*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for function prototypes
*/
virtual QCString trFunctionPrototypeDocumentation()
{ return "Function Prototype Documentation"; }
- /*! This is used in the documentation of a file/namespace before the list
+ /*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for typedefs
*/
virtual QCString trTypedefDocumentation()
{ return "Typedef Documentation"; }
- /*! This is used in the documentation of a file/namespace before the list
+ /*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for enumeration types
*/
virtual QCString trEnumerationTypeDocumentation()
{ return "Enumeration Type Documentation"; }
- /*! This is used in the documentation of a file/namespace before the list
+ /*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for functions
*/
virtual QCString trFunctionDocumentation()
{ return "Function Documentation"; }
- /*! This is used in the documentation of a file/namespace before the list
+ /*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for variables
*/
virtual QCString trVariableDocumentation()
{ return "Variable Documentation"; }
- /*! This is used in the documentation of a file/namespace/group before
+ /*! This is used in the documentation of a file/namespace/group before
* the list of links to documented compounds
*/
virtual QCString trCompounds()
- {
+ {
if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C"))
{
- return "Data Structures";
+ return "Data Structures";
}
else
{
- return "Classes";
+ return "Classes";
}
}
- /*! This is used in the standard footer of each page and indicates when
- * the page was generated
+ /*! This is used in the standard footer of each page and indicates when
+ * the page was generated
*/
virtual QCString trGeneratedAt(const char *date,const char *projName)
- {
+ {
QCString result=(QCString)"Generated on "+date;
if (projName) result+=(QCString)" for "+projName;
result+=(QCString)" by";
@@ -532,7 +525,7 @@ class TranslatorEnglish : public Translator
{
return (QCString)"Inheritance diagram for "+clName+":";
}
-
+
/*! this text is generated when the \\internal command is used. */
virtual QCString trForInternalUseOnly()
{ return "For internal use only."; }
@@ -564,7 +557,7 @@ class TranslatorEnglish : public Translator
/*! this text is generated when the \\exception command is used. */
virtual QCString trExceptions()
{ return "Exceptions"; }
-
+
/*! this text is used in the title page of a LaTeX document. */
virtual QCString trGeneratedBy()
{ return "Generated by"; }
@@ -572,7 +565,7 @@ class TranslatorEnglish : public Translator
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990307
//////////////////////////////////////////////////////////////////////////
-
+
/*! used as the title of page containing all the index of all namespaces. */
virtual QCString trNamespaceList()
{ return "Namespace List"; }
@@ -591,17 +584,17 @@ class TranslatorEnglish : public Translator
*/
virtual QCString trFriends()
{ return "Friends"; }
-
+
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990405
//////////////////////////////////////////////////////////////////////////
-
+
/*! used in the class documentation as a header before the list of all
- * related classes
+ * related classes
*/
virtual QCString trRelatedFunctionDocumentation()
{ return "Friends And Related Function Documentation"; }
-
+
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990425
//////////////////////////////////////////////////////////////////////////
@@ -632,7 +625,7 @@ class TranslatorEnglish : public Translator
virtual QCString trFileReference(const char *fileName)
{
QCString result=fileName;
- result+=" File Reference";
+ result+=" File Reference";
return result;
}
@@ -643,7 +636,7 @@ class TranslatorEnglish : public Translator
result+=" Namespace Reference";
return result;
}
-
+
virtual QCString trPublicMembers()
{ return "Public Member Functions"; }
virtual QCString trPublicSlots()
@@ -664,7 +657,7 @@ class TranslatorEnglish : public Translator
{ return "Private Slots"; }
virtual QCString trStaticPrivateMembers()
{ return "Static Private Member Functions"; }
-
+
/*! this function is used to produce a comma-separated list of items.
* use generateMarker(i) to indicate where item i should be put.
*/
@@ -673,23 +666,23 @@ class TranslatorEnglish : public Translator
QCString result;
int i;
// the inherits list contain `numEntries' classes
- for (i=0;i<numEntries;i++)
+ 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
+ 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
+ if (i<numEntries-2) // not the fore last entry
result+=", ";
else // the fore last entry
result+=", and ";
}
}
- return result;
+ return result;
}
-
+
/*! used in class documentation to produce a list of base classes,
* if class diagrams are disabled.
*/
@@ -706,7 +699,7 @@ class TranslatorEnglish : public Translator
return "Inherited by "+trWriteList(numEntries)+".";
}
- /*! used in member documentation blocks to produce a list of
+ /*! used in member documentation blocks to produce a list of
* members that are hidden by this one.
*/
virtual QCString trReimplementedFromList(int numEntries)
@@ -728,17 +721,17 @@ class TranslatorEnglish : public Translator
/*! This is an introduction to the page with all namespace members */
virtual QCString trNamespaceMemberDescription(bool extractAll)
- {
+ {
QCString result="Here is a list of all ";
if (!extractAll) result+="documented ";
result+="namespace members with links to ";
- if (extractAll)
+ if (extractAll)
result+="the namespace documentation for each member:";
- else
+ else
result+="the namespaces they belong to:";
return result;
}
- /*! This is used in LaTeX as the title of the chapter with the
+ /*! This is used in LaTeX as the title of the chapter with the
* index of all namespaces.
*/
virtual QCString trNamespaceIndex()
@@ -806,7 +799,7 @@ class TranslatorEnglish : public Translator
virtual QCString trMainPage()
{ return "Main Page"; }
- /*! This is used in references to page that are put in the LaTeX
+ /*! This is used in references to page that are put in the LaTeX
* documentation. It should be an abbreviation of the word page.
*/
virtual QCString trPageAbbreviation()
@@ -851,7 +844,7 @@ class TranslatorEnglish : public Translator
/*! header that is put before the list of constructor/destructors. */
virtual QCString trConstructorDocumentation()
{
- return "Constructor & Destructor Documentation";
+ return "Constructor & Destructor Documentation";
}
/*! Used in the file documentation to point to the corresponding sources. */
virtual QCString trGotoSourceCode()
@@ -908,7 +901,7 @@ class TranslatorEnglish : public Translator
//////////////////////////////////////////////////////////////////////////
// new since 1.1.0
//////////////////////////////////////////////////////////////////////////
-
+
virtual QCString trNote()
{
return "Note";
@@ -997,7 +990,7 @@ class TranslatorEnglish : public Translator
{
return "Since";
}
-
+
//////////////////////////////////////////////////////////////////////////
// new since 1.1.5
//////////////////////////////////////////////////////////////////////////
@@ -1007,12 +1000,12 @@ class TranslatorEnglish : public Translator
{
return "Graph Legend";
}
- /*! page explaining how the dot graph's should be interpreted
+ /*! page explaining how the dot graph's should be interpreted
* The %A in the text below are to prevent link to classes called "A".
*/
virtual QCString trLegendDocs()
{
- return
+ return
"This page explains how to interpret the graphs that are generated "
"by doxygen.<p>\n"
"Consider the following example:\n"
@@ -1079,11 +1072,11 @@ class TranslatorEnglish : public Translator
{
return "legend";
}
-
+
//////////////////////////////////////////////////////////////////////////
// new since 1.2.0
//////////////////////////////////////////////////////////////////////////
-
+
/*! Used as a marker that is put before a test item */
virtual QCString trTest()
{
@@ -1161,11 +1154,11 @@ class TranslatorEnglish : public Translator
{
return "Value:";
}
-
+
//////////////////////////////////////////////////////////////////////////
// new since 1.2.5
//////////////////////////////////////////////////////////////////////////
-
+
/*! Used as a marker that is put before a \\bug item */
virtual QCString trBug()
{
@@ -1181,9 +1174,9 @@ class TranslatorEnglish : public Translator
// new since 1.2.6
//////////////////////////////////////////////////////////////////////////
- /*! Used as ansicpg for RTF file
- *
- * The following table shows the correlation of Charset name, Charset Value and
+ /*! Used as ansicpg for RTF file
+ *
+ * The following table shows the correlation of Charset name, Charset Value and
* <pre>
* Codepage number:
* Charset Name Charset Value(hex) Codepage number
@@ -1204,15 +1197,15 @@ class TranslatorEnglish : public Translator
* GB2313_CHARSET 134 (x86) 936
* CHINESEBIG5_CHARSET 136 (x88) 950
* </pre>
- *
+ *
*/
virtual QCString trRTFansicp()
{
return "1252";
}
-
- /*! Used as ansicpg for RTF fcharset
+
+ /*! Used as ansicpg for RTF fcharset
* \see trRTFansicp() for a table of possible values.
*/
virtual QCString trRTFCharSet()
@@ -1225,82 +1218,82 @@ class TranslatorEnglish : public Translator
{
return "Index";
}
-
+
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trClass(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Class" : "class"));
if (!singular) result+="es";
- return result;
+ return result;
}
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trFile(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "File" : "file"));
if (!singular) result+="s";
- return result;
+ return result;
}
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trNamespace(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Namespace" : "namespace"));
if (!singular) result+="s";
- return result;
+ return result;
}
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trGroup(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Group" : "group"));
if (!singular) result+="s";
- return result;
+ return result;
}
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trPage(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Page" : "page"));
if (!singular) result+="s";
- return result;
+ return result;
}
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trMember(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Member" : "member"));
if (!singular) result+="s";
- return result;
+ return result;
}
-
+
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trGlobal(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Global" : "global"));
if (!singular) result+="s";
- return result;
+ return result;
}
//////////////////////////////////////////////////////////////////////////
@@ -1310,10 +1303,10 @@ class TranslatorEnglish : public Translator
/*! This text is generated when the \\author command is used and
* for the author section in man pages. */
virtual QCString trAuthor(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Author" : "author"));
if (!singular) result+="s";
- return result;
+ return result;
}
//////////////////////////////////////////////////////////////////////////
@@ -1331,7 +1324,7 @@ class TranslatorEnglish : public Translator
// new since 1.2.13
//////////////////////////////////////////////////////////////////////////
- /*! used in member documentation blocks to produce a list of
+ /*! used in member documentation blocks to produce a list of
* members that are implemented by this one.
*/
virtual QCString trImplementedFromList(int numEntries)
@@ -1363,8 +1356,8 @@ class TranslatorEnglish : public Translator
// new since 1.2.17
//////////////////////////////////////////////////////////////////////////
- /*! Used as the header of the list of item that have been
- * flagged deprecated
+ /*! Used as the header of the list of item that have been
+ * flagged deprecated
*/
virtual QCString trDeprecatedList()
{
@@ -1375,7 +1368,7 @@ class TranslatorEnglish : public Translator
// new since 1.2.18
//////////////////////////////////////////////////////////////////////////
- /*! Used as a header for declaration section of the events found in
+ /*! Used as a header for declaration section of the events found in
* a C# program
*/
virtual QCString trEvents()
@@ -1395,43 +1388,43 @@ class TranslatorEnglish : public Translator
/*! Used as a heading for a list of Java class types with package scope.
*/
virtual QCString trPackageTypes()
- {
+ {
return "Package Types";
}
- /*! Used as a heading for a list of Java class functions with package
- * scope.
+ /*! Used as a heading for a list of Java class functions with package
+ * scope.
*/
virtual QCString trPackageMembers()
- {
+ {
return "Package Functions";
}
- /*! Used as a heading for a list of static Java class functions with
+ /*! Used as a heading for a list of static Java class functions with
* package scope.
*/
virtual QCString trStaticPackageMembers()
- {
+ {
return "Static Package Functions";
}
- /*! Used as a heading for a list of Java class variables with package
+ /*! Used as a heading for a list of Java class variables with package
* scope.
*/
virtual QCString trPackageAttribs()
- {
+ {
return "Package Attributes";
}
- /*! Used as a heading for a list of static Java class variables with
+ /*! Used as a heading for a list of static Java class variables with
* package scope.
*/
virtual QCString trStaticPackageAttribs()
- {
+ {
return "Static Package Attributes";
}
-
+
//////////////////////////////////////////////////////////////////////////
// new since 1.3.1
//////////////////////////////////////////////////////////////////////////
- /*! Used in the quick index of a class/file/namespace member list page
+ /*! Used in the quick index of a class/file/namespace member list page
* to link to the unfiltered list of all members.
*/
virtual QCString trAll()
@@ -1448,9 +1441,9 @@ class TranslatorEnglish : public Translator
// new since 1.3.3
//////////////////////////////////////////////////////////////////////////
- /*! When the search engine is enabled this text is put in the header
- * of each page before the field where one can enter the text to search
- * for.
+ /*! When the search engine is enabled this text is put in the header
+ * of each page before the field where one can enter the text to search
+ * for.
*/
virtual QCString trSearchForIndex()
{
@@ -1467,7 +1460,7 @@ class TranslatorEnglish : public Translator
* 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 @a numDocuments parameter can be either 0, 1 or 2, where the
+ * The @a 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.
*/
@@ -1481,13 +1474,13 @@ class TranslatorEnglish : public Translator
{
return "Found <b>1</b> document matching your query.";
}
- else
+ else
{
return "Found <b>$num</b> documents matching your query. "
"Showing best matches first.";
}
}
- /*! This string is put before the list of matched words, for each search
+ /*! 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.
*/
virtual QCString trSearchMatches()
@@ -1528,7 +1521,7 @@ class TranslatorEnglish : public Translator
virtual QCString trDirectories()
{ return "Directories"; }
- /*! This returns a sentences that introduces the directory hierarchy.
+ /*! This returns a sentences that introduces the directory hierarchy.
* and the fact that it is sorted alphabetically per level
*/
virtual QCString trDirDescription()
@@ -1546,10 +1539,10 @@ class TranslatorEnglish : public Translator
* (\a first_capital) and in sigular or plural form (\a singular).
*/
virtual QCString trDir(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Director" : "director"));
if (singular) result+="y"; else result+="ies";
- return result;
+ return result;
}
//////////////////////////////////////////////////////////////////////////
@@ -1576,7 +1569,7 @@ class TranslatorEnglish : public Translator
return "Here is the caller graph for this function:";
}
- /*! This is used in the documentation of a file/namespace before the list
+ /*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for enumeration values
*/
virtual QCString trEnumerationValueDocumentation()
@@ -1585,12 +1578,12 @@ class TranslatorEnglish : public Translator
//////////////////////////////////////////////////////////////////////////
// new since 1.5.4 (mainly for Fortran)
//////////////////////////////////////////////////////////////////////////
-
+
/*! header that is put before the list of member subprograms (Fortran). */
virtual QCString trMemberFunctionDocumentationFortran()
{ return "Member Function/Subroutine Documentation"; }
- /*! This is put above each page as a link to the list of annotated data types (Fortran). */
+ /*! This is put above each page as a link to the list of annotated data types (Fortran). */
virtual QCString trCompoundListFortran()
{ return "Data Types List"; }
@@ -1612,18 +1605,18 @@ class TranslatorEnglish : public Translator
}
result+="data types members";
result+=" with links to ";
- if (!extractAll)
+ if (!extractAll)
{
result+="the data structure documentation for each member";
}
- else
+ else
{
result+="the data types they belong to:";
}
return result;
}
- /*! This is used in LaTeX as the title of the chapter with the
+ /*! This is used in LaTeX as the title of the chapter with the
* annotated compound index (Fortran).
*/
virtual QCString trCompoundIndexFortran()
@@ -1635,24 +1628,24 @@ class TranslatorEnglish : public Translator
virtual QCString trTypeDocumentation()
{ return "Data Type Documentation"; }
- /*! This is used in the documentation of a file as a header before the
+ /*! This is used in the documentation of a file as a header before the
* list of (global) subprograms (Fortran).
*/
virtual QCString trSubprograms()
{ return "Functions/Subroutines"; }
- /*! This is used in the documentation of a file/namespace before the list
+ /*! This is used in the documentation of a file/namespace before the list
* of documentation blocks for subprograms (Fortran)
*/
virtual QCString trSubprogramDocumentation()
{ return "Function/Subroutine Documentation"; }
- /*! This is used in the documentation of a file/namespace/group before
+ /*! This is used in the documentation of a file/namespace/group before
* the list of links to documented compounds (Fortran)
*/
virtual QCString trDataTypes()
{ return "Data Types"; }
-
+
/*! used as the title of page containing all the index of all modules (Fortran). */
virtual QCString trModulesList()
{ return "Modules List"; }
@@ -1691,46 +1684,46 @@ class TranslatorEnglish : public Translator
virtual QCString trModuleReference(const char *namespaceName)
{
QCString result=namespaceName;
- result+=" Module Reference";
+ result+=" Module Reference";
return result;
}
-
+
/*! This is put above each page as a link to all members of modules. (Fortran) */
virtual QCString trModulesMembers()
{ return "Module Members"; }
/*! This is an introduction to the page with all modules members (Fortran) */
virtual QCString trModulesMemberDescription(bool extractAll)
- {
+ {
QCString result="Here is a list of all ";
if (!extractAll) result+="documented ";
result+="module members with links to ";
- if (extractAll)
+ if (extractAll)
{
result+="the module documentation for each member:";
}
- else
+ else
{
result+="the modules they belong to:";
}
return result;
}
- /*! This is used in LaTeX as the title of the chapter with the
+ /*! This is used in LaTeX as the title of the chapter with the
* index of all modules (Fortran).
*/
virtual QCString trModulesIndex()
{ return "Modules Index"; }
-
+
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trModule(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Module" : "module"));
if (!singular) result+="s";
- return result;
+ return result;
}
/*! This is put at the bottom of a module documentation page and is
@@ -1758,25 +1751,25 @@ class TranslatorEnglish : public Translator
}
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trType(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Type" : "type"));
if (!singular) result+="s";
- return result;
+ return result;
}
/*! This is used for translation of the word that will possibly
- * be followed by a single name or by a list of names
+ * be followed by a single name or by a list of names
* of the category.
*/
virtual QCString trSubprogram(bool first_capital, bool singular)
- {
+ {
QCString result((first_capital ? "Subprogram" : "subprogram"));
if (!singular) result+="s";
- return result;
+ return result;
}
/*! C# Type Constraint list */
@@ -1847,7 +1840,7 @@ class TranslatorEnglish : public Translator
return (QCString)"Includes file in "+name;
}
- /** Compiles a date string.
+ /** Compiles a date string.
* @param year Year in 4 digits
* @param month Month of the year: 1=January
* @param day Day of the Month: 1..31
@@ -1922,8 +1915,8 @@ class TranslatorEnglish : public Translator
virtual QCString trInheritedFrom(const char *members,const char *what)
{ return QCString(members)+" inherited from "+what; }
- /*! Header of the sections with inherited members specific for the
- * base class(es)
+ /*! Header of the sections with inherited members specific for the
+ * base class(es)
*/
virtual QCString trAdditionalInheritedMembers()
{ return "Additional Inherited Members"; }
@@ -1933,7 +1926,7 @@ class TranslatorEnglish : public Translator
//////////////////////////////////////////////////////////////////////////
/*! Used as a tooltip for the toggle button that appears in the
- * navigation tree in the HTML output when GENERATE_TREEVIEW is
+ * navigation tree in the HTML output when GENERATE_TREEVIEW is
* enabled. This tooltip explains the meaning of the button.
*/
virtual QCString trPanelSynchronisationTooltip(bool enable)