[Doxygen-develop] PATCH: file titles
Brought to you by:
dimitri
From: Akos K. <ak...@us...> - 2003-12-15 00:41:24
|
Hi all, I discovered a small bug in the generation of titles of (HTML) files. The title for a template class X looks like " TemplateX class Reference". The word "class" should start with a capital C and a space is placed on a wrong place. But! When I analysed how file titles are generated I found that the title strings are hardcoded english into the sources and not built using the translator technique. In the 4 (at least for me) most important cases I've replaced the hardcoded strings with translator calls (and made the file titles the same as the titles on the pages). Patch is attached. However, there are still lots of hardcoded english file titles throughout the program, mostly in index.cpp, which should be eliminated. Below is the list of problems I've found. In the first 2 cases there is currently no translator function which could be used. In the case of classdef.cpp, the signature of the called trMemberList should be changed to accept the name of the compound as a parameter to give the responsibility of inserting the class name into the phrase to the translator function. In index.cpp lots of files are created with hardcoded file titles. In those cases translator functions are already used to translate the _page_ titles but not the file titles. The best solution would be (IMHO) to use the same phrases in the file and page titles, with the only difference that on page titles the project name should also appear. Unfortunately this solution (and the solutions to the above problems) would change the interface of the translator and would need some work on the language side. I don't know who is going to decide, but well, at least now the problem is known. filedef.cpp: " Source File" doxygen.cpp: "Example Documentation" classdef.cpp: trMemberList() -> trMemberList(string) index.cpp: "Hierarchical Index"->trClassHierarchy, "Graphical Class Hierarchy"->trGraphicalHierarchy, "File Index"->trFileList, "Package Index"->trPackageList, "Namespace Index"->trNamespaceList,"Alphabetical index"->trCompoundIndex, "Annotated Index"->trCompoundList, "Compound Member Index"->trCompoundMembers, "File Member Index"->trFileMembers, "Namespace Member Index"->trNamespaceMembers,"Example Index"->trExamples, "Page Index"->trRelatedPages, "Graph Legend"->trLegendTitle, "Module Index"->trModules Regards, Akos 2003-12-15 Akos Kiss <ak...@us...> * classdef.cpp (ClassDef::writeDocumentation, ClassDef::writeMemberList): File title and page title made the same. * filedef.cpp (FileDef::writeDocumentation): Likewise. * namespacedef.cpp (NamespaceDef::writeDocumentation): Likewise. |