summaryrefslogtreecommitdiffstats
path: root/src/translator.h
diff options
context:
space:
mode:
authormueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7>1999-12-15 19:34:06 (GMT)
committermueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7>1999-12-15 19:34:06 (GMT)
commitf18128845407f8612668950e112c2d5c3e0ff5be (patch)
tree43e0b215b5d3d2b436509cbb1cd22102aef61b1d /src/translator.h
parentdaf91dc906e217e81f77f491e0abf505a91289b8 (diff)
downloadDoxygen-f18128845407f8612668950e112c2d5c3e0ff5be.zip
Doxygen-f18128845407f8612668950e112c2d5c3e0ff5be.tar.gz
Doxygen-f18128845407f8612668950e112c2d5c3e0ff5be.tar.bz2
mods for doxygen-0.49-990829
Diffstat (limited to 'src/translator.h')
-rw-r--r--src/translator.h441
1 files changed, 292 insertions, 149 deletions
diff --git a/src/translator.h b/src/translator.h
index d5c4f67..e81ff92 100644
--- a/src/translator.h
+++ b/src/translator.h
@@ -42,148 +42,163 @@ class Translator
{ return "Reimplemented in"; }
virtual QCString trIncludeFile()
{ return "Include File"; }
+ virtual QCString trGeneratedFrom(const char *s,bool single)
+ {
+ QCString result=(QCString)"The documentation for this"+s+
+ " was generated from the following file";
+ if (single) result+=":"; else result+="s:";
+ return result;
+ }
// end of obsolete functions
//--------------------------------------------------------------------
+ /*! returns the name of the package that is included by LaTeX */
virtual QCString latexBabelPackage()
- // returns the name of the package that is included by LaTeX
{ return ""; }
+ /*! used in the compound documentation before a list of related functions. */
virtual QCString trRelatedFunctions()
- // used in the compound documentation before a list of related functions.
{ return "Related Functions"; }
+ /*! subscript for the related functions. */
virtual QCString trRelatedSubscript()
- // subscript for the related functions.
{ return "(Note that these are not member functions.)"; }
+ /*! header that is put before the detailed description of files, classes and namespaces. */
virtual QCString trDetailedDescription()
- // header that is put before the detailed description of files, classes and namespaces.
{ return "Detailed Description"; }
+ /*! header that is put before the list of typedefs. */
virtual QCString trMemberTypedefDocumentation()
- // header that is put before the list of typedefs.
{ return "Member Typedef Documentation"; }
+ /*! header that is put before the list of enumerations. */
virtual QCString trMemberEnumerationDocumentation()
- // header that is put before the list of enumerations.
{ return "Member Enumeration Documentation"; }
+ /*! header that is put before the list of member functions. */
virtual QCString trMemberFunctionDocumentation()
- // header that is put before the list of member functions.
{ return "Member Function Documentation"; }
+ /*! header that is put before the list of member attributes. */
virtual QCString trMemberDataDocumentation()
- // header that is put before the list of member attributes.
{ return "Member Data Documentation"; }
-
- virtual QCString trGeneratedFrom(const char *s,bool single)
- { // here s is one of " Class", " Struct" or " Union"
- // single is true implies a single file
- QCString result=(QCString)"The documentation for this"+s+
- " was generated from the following file";
- if (single) result+=":"; else result+="s:";
- return result;
- }
+ /*! this is the text of a link put after brief descriptions. */
virtual QCString trMore()
- // this is the text of a link put after brief descriptions.
{ return "More..."; }
+ /*! put in the class documentation */
virtual QCString trListOfAllMembers()
- // put in the class documentation
{ return "List of all members."; }
+ /*! used as the title of the "list of all members" page of a class */
virtual QCString trMemberList()
- // used as the title of the "list of all members" page of a class
{ return "Member List"; }
+ /*! this is the first part of a sentence that is followed by a class name */
virtual QCString trThisIsTheListOfAllMembers()
- // this is the first part of a sentence that is followed by a class name
{ return "This is the complete list of members for "; }
+
+ /*! this is the remainder of the sentence after the class name */
virtual QCString trIncludingInheritedMembers()
- // this is the remainder of the sentence after the class name
{ 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)
- // this is put at the author sections at the bottom of man pages.
- // parameter s is name of the project name.
{ QCString result="Generated automatically by Doxygen";
if (s) result+=(QCString)" for "+s;
result+=" from the source code.";
return result;
}
+ /*! put after an enum name in the list of all members */
virtual QCString trEnumName()
- // put after an enum name in the list of all members
{ return "enum name"; }
+ /*! put after an enum value in the list of all members */
virtual QCString trEnumValue()
- // put after an enum value in the list of all members
{ return "enum value"; }
+ /*! put after an undocumented member in the list of all members */
virtual QCString trDefinedIn()
- // put after an undocumented member in the list of all members
{ return "defined in"; }
+ /*! put as in introduction in the verbatim header file of a class.
+ * parameter f is the name of the include file.
+ */
virtual QCString trVerbatimText(const char *f)
- // put as in introduction in the verbatim header file of a class.
- // parameter f is the name of the include file.
{ return (QCString)"This is the verbatim text of the "+f+" include file."; }
// quick reference sections
+
+ /*! 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()
- // This is put above each page as a link to the list of all groups of
- // compounds or files (see the \group command).
{ return "Modules"; }
+
+ /*! This is put above each page as a link to the class hierarchy */
virtual QCString trClassHierarchy()
- // This is put above each page as a link to the class hierarchy
{ return "Class Hierarchy"; }
+
+ /*! This is put above each page as a link to the list of annotated classes */
virtual QCString trCompoundList()
- // This is put above each page as a link to the list of annotated classes
{ return "Compound List"; }
+
+ /*! This is put above each page as a link to the list of documented files */
virtual QCString trFileList()
- // This is put above each page as a link to the list of documented files
{ return "File List"; }
+
+ /*! This is put above each page as a link to the list of all verbatim headers */
virtual QCString trHeaderFiles()
- // This is put above each page as a link to the list of all verbatim headers
{ return "Header Files"; }
+
+ /*! This is put above each page as a link to all members of compounds. */
virtual QCString trCompoundMembers()
- // This is put above each page as a link to all members of compounds.
{ return "Compound Members"; }
+
+ /*! This is put above each page as a link to all members of files. */
virtual QCString trFileMembers()
- // This is put above each page as a link to all members of files.
{ return "File Members"; }
+
+ /*! This is put above each page as a link to all related pages. */
virtual QCString trRelatedPages()
- // This is put above each page as a link to all related pages.
{ return "Related Pages"; }
+
+ /*! This is put above each page as a link to all examples. */
virtual QCString trExamples()
- // This is put above each page as a link to all examples.
{ return "Examples"; }
+
+ /*! This is put above each page as a link to the search engine. */
virtual QCString trSearch()
- // This is put above each page as a link to the search engine.
{ return "Search"; }
+ /*! This is an introduction to the class hierarchy. */
virtual QCString trClassHierarchyDescription()
- // This is an introduction to the class hierarchy.
{ return "This inheritance list is sorted roughly, "
"but not completely, alphabetically:";
}
+
+ /*! This is an introduction to the list with all files. */
virtual QCString trFileListDescription(bool extractAll)
- // This is an introduction to the list with all files.
{
QCString result="Here is a list of all ";
if (!extractAll) result+="documented ";
result+="files with brief descriptions:";
return result;
}
+
+ /*! This is an introduction to the annotated compound list. */
virtual QCString trCompoundListDescription()
- // This is an introduction to the annotated compound list
{ return "Here are the classes, structs and "
"unions with brief descriptions:";
}
+
+ /*! This is an introduction to the page with all class members. */
virtual QCString trCompoundMembersDescription(bool extractAll)
- // This is an introduction to the page with all class members
{
QCString result="Here is a list of all ";
if (!extractAll) result+="documented ";
@@ -194,8 +209,9 @@ class Translator
result+="the classes they belong to:";
return result;
}
+
+ /*! This is an introduction to the page with all file members. */
virtual QCString trFileMembersDescription(bool extractAll)
- // This is an introduction to the page with all file members
{
QCString result="Here is a list of all ";
if (!extractAll) result+="documented ";
@@ -206,137 +222,197 @@ class Translator
result+="the files they belong to:";
return result;
}
+
+ /*! This is an introduction to the page with the list of all header files. */
virtual QCString trHeaderFilesDescription()
- // This is an introduction to the page with the list of all header files
{ return "Here are the header files that make up the API:"; }
+
+ /*! This is an introduction to the page with the list of all examples */
virtual QCString trExamplesDescription()
- // This is an introduction to the page with the list of all examples
{ return "Here is a list of all examples:"; }
+
+ /*! This is an introduction to the page with the list of related pages */
virtual QCString trRelatedPagesDescription()
- // This is an introduction to the page with the list of related pages
{ return "Here is a list of all related documentation pages:"; }
+
+ /*! This is an introduction to the page with the list of class/file groups */
virtual QCString trModulesDescription()
- // This is an introduction to the page with the list of class/file groups
{ return "Here is a list of all modules:"; }
+
+ /*! This sentences is used in the annotated class/file lists if no brief
+ * description is given.
+ */
virtual QCString trNoDescriptionAvailable()
- // This sentences is used in the annotated class/file lists if no brief
- // description is given.
{ return "No description available"; }
// index titles (the project name is prepended for these)
+
+
+ /*! This is used in HTML as the title of index.html. */
virtual QCString trDocumentation()
- // This is used in HTML as the title of index.html.
{ return "Documentation"; }
+
+ /*! This is used in LaTeX as the title of the chapter with the
+ * index of all groups.
+ */
virtual QCString trModuleIndex()
- // This is used in LaTeX as the title of the chapter with the
- // index of all groups.
{ return "Module Index"; }
+
+ /*! This is used in LaTeX as the title of the chapter with the
+ * class hierarchy.
+ */
virtual QCString trHierarchicalIndex()
- // This is used in LaTeX as the title of the chapter with the
- // class hierarchy.
{ return "Hierarchical Index"; }
+
+ /*! This is used in LaTeX as the title of the chapter with the
+ * annotated compound index.
+ */
virtual QCString trCompoundIndex()
- // This is used in LaTeX as the title of the chapter with the
- // annotated compound index
{ return "Compound Index"; }
+
+ /*! This is used in LaTeX as the title of the chapter with the
+ * list of all files.
+ */
virtual QCString trFileIndex()
- // This is used in LaTeX as the title of the chapter with the
- // list of all files.
{ return "File Index"; }
+
+ /*! This is used in LaTeX as the title of the chapter containing
+ * the documentation of all groups.
+ */
virtual QCString trModuleDocumentation()
- // This is used in LaTeX as the title of the chapter containing
- // the documentation of all groups.
{ return "Module Documentation"; }
+
+ /*! This is used in LaTeX as the title of the chapter containing
+ * the documentation of all classes, structs and unions.
+ */
virtual QCString trClassDocumentation()
- // This is used in LaTeX as the title of the chapter containing
- // the documentation of all classes, structs and unions.
{ return "Class Documentation"; }
+
+ /*! This is used in LaTeX as the title of the chapter containing
+ * the documentation of all files.
+ */
virtual QCString trFileDocumentation()
- // This is used in LaTeX as the title of the chapter containing
- // the documentation of all files.
{ return "File Documentation"; }
+
+ /*! This is used in LaTeX as the title of the chapter containing
+ * the documentation of all examples.
+ */
virtual QCString trExampleDocumentation()
- // This is used in LaTeX as the title of the chapter containing
- // the documentation of all examples.
{ return "Example Documentation"; }
+
+ /*! This is used in LaTeX as the title of the chapter containing
+ * the documentation of all related pages.
+ */
virtual QCString trPageDocumentation()
- // This is used in LaTeX as the title of the chapter containing
- // the documentation of all related pages.
{ return "Page Documentation"; }
+
+ /*! This is used in LaTeX as the title of the document */
virtual QCString trReferenceManual()
- // This is used in LaTeX as the title of the document
{ return "Reference Manual"; }
+ /*! This is used in the documentation of a file as a header before the
+ * list of defines
+ */
virtual QCString trDefines()
- // This is used in the documentation of a file as a header before the
- // list of defines
{ return "Defines"; }
+
+ /*! This is used in the documentation of a file as a header before the
+ * list of function prototypes
+ */
virtual QCString trFuncProtos()
- // This is used in the documentation of a file as a header before the
- // list of function prototypes
{ return "Function Prototypes"; }
+
+ /*! This is used in the documentation of a file as a header before the
+ * list of typedefs
+ */
virtual QCString trTypedefs()
- // This is used in the documentation of a file as a header before the
- // list of typedefs
{ return "Typedefs"; }
+
+ /*! This is used in the documentation of a file as a header before the
+ * list of enumerations
+ */
virtual QCString trEnumerations()
- // This is used in the documentation of a file as a header before the
- // list of enumerations
{ return "Enumerations"; }
+
+ /*! This is used in the documentation of a file as a header before the
+ * list of (global) functions
+ */
virtual QCString trFunctions()
- // This is used in the documentation of a file as a header before the
- // list of (global) functions
{ return "Functions"; }
+
+ /*! This is used in the documentation of a file as a header before the
+ * list of (global) variables
+ */
virtual QCString trVariables()
- // This is used in the documentation of a file as a header before the
- // list of (global) variables
{ return "Variables"; }
+
+ /*! This is used in the documentation of a file as a header before the
+ * list of (global) variables
+ */
virtual QCString trEnumerationValues()
- // This is used in the documentation of a file as a header before the
- // list of (global) variables
{ return "Enumeration values"; }
+ /*! This is used in man pages as the author section. */
virtual QCString trAuthor()
- // This is used in man pages as the author section.
{ return "Author"; }
+ /*! This is used in the documentation of a file before the list of
+ * documentation blocks for defines
+ */
virtual QCString trDefineDocumentation()
- // This is used in the documentation of a file before the list of
- // documentation blocks for defines
{ return "Define Documentation"; }
+
+ /*! This is used in the documentation of a file/namespace before the list
+ * of documentation blocks for function prototypes
+ */
virtual QCString trFunctionPrototypeDocumentation()
- // This is used in the documentation of a file/namespace before the list
- // of documentation blocks for function prototypes
{ return "Function Prototype Documentation"; }
+
+ /*! This is used in the documentation of a file/namespace before the list
+ * of documentation blocks for typedefs
+ */
virtual QCString trTypedefDocumentation()
- // This is used in the documentation of a file/namespace before the list
- // of documentation blocks for typedefs
{ return "Typedef Documentation"; }
+
+ /*! This is used in the documentation of a file/namespace before the list
+ * of documentation blocks for enumeration types
+ */
virtual QCString trEnumerationTypeDocumentation()
- // This is used in the documentation of a file/namespace before the list
- // of documentation blocks for enumeration types
{ return "Enumeration Type Documentation"; }
+
+ /*! This is used in the documentation of a file/namespace before the list
+ * of documentation blocks for enumeration values
+ */
virtual QCString trEnumerationValueDocumentation()
- // This is used in the documentation of a file/namespace before the list
- // of documentation blocks for enumeration values
{ return "Enumeration Value Documentation"; }
+
+ /*! This is used in the documentation of a file/namespace before the list
+ * of documentation blocks for functions
+ */
virtual QCString trFunctionDocumentation()
- // This is used in the documentation of a file/namespace before the list
- // of documentation blocks for functions
{ return "Function Documentation"; }
+
+ /*! This is used in the documentation of a file/namespace before the list
+ * of documentation blocks for variables
+ */
virtual QCString trVariableDocumentation()
- // This is used in the documentation of a file/namespace before the list
- // of documentation blocks for variables
{ return "Variable Documentation"; }
+
+ /*! This is used in the documentation of a file/namespace/group before
+ * the list of links to documented compounds
+ */
virtual QCString trCompounds()
- // This is used in the documentation of a file/namespace/group before
- // the list of links to documented compounds
{ return "Compounds"; }
+
+ /*! This is used in the documentation of a group before the list of
+ * links to documented files
+ */
virtual QCString trFiles()
- // This is used in the documentation of a group before the list of
- // links to documented files
{ return "Files"; }
+ /*! 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 at "+date;
@@ -344,116 +420,137 @@ class Translator
result+=(QCString)" by";
return result;
}
+ /*! This is part of the sentence used in the standard footer of each page.
+ */
virtual QCString trWrittenBy()
{
return "written by";
}
+ /*! this text is put before a class diagram */
virtual QCString trClassDiagram(const char *clName)
- // this text is put before a class diagram
{
return (QCString)"Class diagram for "+clName;
}
+ /*! this text is generated when the \internal command is used. */
virtual QCString trForInternalUseOnly()
- // this text is generated when the \internal command is used.
{ return "For internal use only."; }
+
+ /*! this text is generated when the \reimp command is used. */
virtual QCString trReimplementedForInternalReasons()
- // this text is generated when the \reimp command is used.
{ return "Reimplemented for internal reasons; the API is not affected."; }
+
+ /*! this text is generated when the \warning command is used. */
virtual QCString trWarning()
- // this text is generated when the \warning command is used.
{ return "Warning"; }
+
+ /*! this text is generated when the \bug command is used. */
virtual QCString trBugsAndLimitations()
- // this text is generated when the \bug command is used.
{ return "Bugs and limitations"; }
+
+ /*! this text is generated when the \version command is used. */
virtual QCString trVersion()
- // this text is generated when the \version command is used.
{ return "Version"; }
+
+ /*! this text is generated when the \date command is used. */
virtual QCString trDate()
- // this text is generated when the \date command is used.
{ return "Date"; }
+
+ /*! this text is generated when the \author command is used. */
virtual QCString trAuthors()
- // this text is generated when the \author command is used.
{ return "Author(s)"; }
+
+ /*! this text is generated when the \return command is used. */
virtual QCString trReturns()
- // this text is generated when the \return command is used.
{ return "Returns"; }
+
+ /*! this text is generated when the \sa command is used. */
virtual QCString trSeeAlso()
- // this text is generated when the \sa command is used.
{ return "See also"; }
+
+ /*! this text is generated when the \param command is used. */
virtual QCString trParameters()
- // this text is generated when the \param command is used.
{ return "Parameters"; }
+
+ /*! this text is generated when the \exception command is used. */
virtual QCString trExceptions()
- // this text is generated when the \exception command is used.
{ return "Exceptions"; }
+ /*! this text is used in the title page of a LaTeX document. */
virtual QCString trGeneratedBy()
- // this text is used in the title page of a LaTeX document.
{ return "Generated by"; }
// new since 0.49-990307
+ /*! used as the title of page containing all the index of all namespaces. */
virtual QCString trNamespaceList()
- // used as the title of page containing all the index of all namespaces.
{ return "Namespace List"; }
+
+ /*! used as an introduction to the namespace list */
virtual QCString trNamespaceListDescription(bool extractAll)
- // used as an introduction to the namespace list
{
QCString result="Here is a list of all ";
if (!extractAll) result+="documented ";
result+="namespaces with brief descriptions:";
return result;
}
+
+ /*! used in the class documentation as a header before the list of all
+ * friends of a class
+ */
virtual QCString trFriends()
- // used in the class documentation as a header before the list of all
- // friends of a class
{ return "Friends"; }
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990405
//////////////////////////////////////////////////////////////////////////
+ /*! used in the class documentation as a header before the list of all
+ * related classes
+ */
virtual QCString trRelatedFunctionDocumentation()
- // used in the class documentation as a header before the list of all
- // related classes
{ return "Friends And Related Function Documentation"; }
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990425
//////////////////////////////////////////////////////////////////////////
+ /*! used as the title of the HTML page of a class/struct/union */
virtual QCString trCompoundReference(const char *clName,
ClassDef::CompoundType compType)
- // used as the title of the HTML page of a class/struct/union
{
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::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
}
result+=" Reference";
return result;
}
+
+ /*! used as the title of the HTML page of a file */
virtual QCString trFileReference(const char *fileName)
- // used as the title of the HTML page of a file
{
QCString result=fileName;
result+=" File Reference";
return result;
}
+
+ /*! used as the title of the HTML page of a namespace */
virtual QCString trNamespaceReference(const char *namespaceName)
- // used as the title of the HTML page of a namespace
{
QCString result=namespaceName;
result+=" Namespace Reference";
return result;
}
- // these are for the member sections of a class, struct or union
+ /*! \mgroup Class sections
+ * these are for the member sections of a class, struct or union
+ */
virtual QCString trPublicMembers()
{ return "Public Members"; }
virtual QCString trPublicSlots()
@@ -474,12 +571,13 @@ class Translator
{ return "Private Slots"; }
virtual QCString trStaticPrivateMembers()
{ return "Static Private Members"; }
- // end of member sections
+ /*! \endmgroup */
+ /*! this function is used to produce a comma-separated list of items.
+ * use generateMarker(i) to indicate where item i should be put.
+ */
virtual QCString trWriteList(int numEntries)
{
- // this function is used to produce a comma-separated list of items.
- // use generateMarker(i) to indicate where item i should be put.
QCString result;
int i;
// the inherits list contain `numEntries' classes
@@ -500,36 +598,44 @@ class Translator
return result;
}
+ /*! used in class documentation to produce a list of base classes,
+ * if class diagrams are disabled.
+ */
virtual QCString trInheritsList(int numEntries)
- // used in class documentation to produce a list of base classes,
- // if class diagrams are disabled.
{
return "Inherits "+trWriteList(numEntries)+".";
}
+
+ /*! used in class documentation to produce a list of super classes,
+ * if class diagrams are disabled.
+ */
virtual QCString trInheritedByList(int numEntries)
- // used in class documentation to produce a list of super classes,
- // if class diagrams are disabled.
{
return "Inherited by "+trWriteList(numEntries)+".";
}
+
+ /*! used in member documentation blocks to produce a list of
+ * members that are hidden by this one.
+ */
virtual QCString trReimplementedFromList(int numEntries)
- // used in member documentation blocks to produce a list of
- // members that are hidden by this one.
{
return "Reimplemented from "+trWriteList(numEntries)+".";
}
+
+ /*! used in member documentation blocks to produce a list of
+ * all member that overwrite the implementation of this member.
+ */
virtual QCString trReimplementedInList(int numEntries)
{
- // used in member documentation blocks to produce a list of
- // all member that overwrite the implementation of this member.
return "Reimplemented in "+trWriteList(numEntries)+".";
}
+ /*! This is put above each page as a link to all members of namespaces. */
virtual QCString trNamespaceMembers()
- // This is put above each page as a link to all members of namespaces.
{ return "Namespace Members"; }
+
+ /*! This is an introduction to the page with all namespace members */
virtual QCString trNamespaceMemberDescription(bool extractAll)
- // This is an introduction to the page with all namespace members
{
QCString result="Here is a list of all ";
if (!extractAll) result+="documented ";
@@ -540,23 +646,60 @@ class Translator
result+="the namespaces they belong to:";
return result;
}
+ /*! This is used in LaTeX as the title of the chapter with the
+ * index of all namespaces.
+ */
virtual QCString trNamespaceIndex()
- // This is used in LaTeX as the title of the chapter with the
- // index of all namespaces.
{ return "Namespace Index"; }
+
+ /*! This is used in LaTeX as the title of the chapter containing
+ * the documentation of all namespaces.
+ */
virtual QCString trNamespaceDocumentation()
- // This is used in LaTeX as the title of the chapter containing
- // the documentation of all namespaces.
{ return "Namespace Documentation"; }
//////////////////////////////////////////////////////////////////////////
// new since 0.49-990522
//////////////////////////////////////////////////////////////////////////
- // This is used in the documentation before the list of all
- // namespaces in a file.
+ /*! This is used in the documentation before the list of all
+ * namespaces in a file.
+ */
virtual QCString trNamespaces()
{ return "Namespaces"; }
+
+//////////////////////////////////////////////////////////////////////////
+// new since 0.49-990728
+//////////////////////////////////////////////////////////////////////////
+
+ /*! 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.
+ */
+ virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType,
+ bool single)
+ { // here s is one of " Class", " Struct" or " Union"
+ // 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;
+ }
+ result+="was generated from the following file";
+ if (single) result+=":"; else result+="s:";
+ return result;
+ }
+
+ /*! This is in the (quick) index as a link to the alphabetical compound
+ * list.
+ */
+ virtual QCString trAlphabeticalList()
+ {
+ return "Alphabetical List";
+ }
};
+
#endif