diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/autolink.doc | 2 | ||||
| -rw-r--r-- | doc/doxygen_manual.tex | 2 | ||||
| -rw-r--r-- | doc/features.doc | 32 | ||||
| -rw-r--r-- | doc/index.doc | 2 | ||||
| -rw-r--r-- | doc/language.doc | 134 | ||||
| -rw-r--r-- | doc/translator.py | 6 | ||||
| -rw-r--r-- | doc/translator_report.txt | 115 |
8 files changed, 106 insertions, 189 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index 01014fa..0c06390 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -34,7 +34,7 @@ IMAGE_PATH = . INPUT = index.doc install.doc starting.doc docblocks.doc lists.doc \ grouping.doc formulas.doc diagrams.doc preprocessing.doc \ autolink.doc output.doc searching.doc customize.doc custcmd.doc \ - external.doc faq.doc trouble.doc history.doc features.doc \ + external.doc faq.doc trouble.doc features.doc \ doxygen_usage.doc doxytag_usage.doc \ doxywizard_usage.doc installdox_usage.doc \ config.doc commands.doc htmlcmds.doc xmlcmds.doc language.doc \ diff --git a/doc/autolink.doc b/doc/autolink.doc index 0325a7a..8279d90 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -82,7 +82,7 @@ the patterns above. \par Note 4: In the documentation of a class containing a member foo, - a reference to a global variable is made using ::foo, whereas \#foo + a reference to a global variable is made using "::foo", whereas \#foo will link to the member. For non overloaded members the argument list may be omitted. diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index a755c19..a10cddd 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -17,6 +17,7 @@ \usepackage{makeidx} \usepackage{fancyhdr} \usepackage{float} +\usepackage{longtable} \usepackage{graphicx} \usepackage{epsf} \usepackage{doxygen} @@ -68,7 +69,6 @@ Written by Dimitri van Heesch\\[2ex] \chapter{Troubleshooting}\label{trouble}\hypertarget{trouble}{}\input{trouble} \part{Reference Manual} \chapter{Features}\label{features}\hypertarget{features}{}\input{features} -\chapter{Doxygen History}\label{history}\hypertarget{history}{}\input{history} \chapter{Doxygen usage}\label{doxygen_usage}\hypertarget{doxygen_usage}{}\input{doxygen_usage} \chapter{Doxytag usage}\label{doxytag_usage}\hypertarget{doxytag_usage}{}\input{doxytag_usage} \chapter{Doxywizard usage}\label{doxywizard_usage}\hypertarget{doxywizard_usage}{}\input{doxywizard_usage} diff --git a/doc/features.doc b/doc/features.doc index b1ebf0c..c1615ec 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -21,30 +21,41 @@ <li>Requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used. -<li>Supports C/C++, Java, (Corba and Microsoft) Java, Python, - IDL, C#, Objective-C and to some extent D and PHP sources. +<li>Cross platform: works on Windows and many Unices (including Linux and + MacOSX). +<li>Indexes, organizes and generates browsable and cross-referenced + output even from undocumented code. +<li>Generates structured XML output for parsed sources, which can be + used by external tools. +<li>Supports C/C++, Java, (Corba and Microsoft) Java, Python, VHDL, PHP + IDL, C#, Objective-C 2.0, and to some extent D and Fortran sources. <li>Supports documentation of files, namespaces, packages, classes, structs, unions, templates, variables, functions, typedefs, enums and defines. -<li>JavaDoc (1.1), Qt-Doc, and ECMA-334 (C# spec.) compatible. +<li>JavaDoc (1.1), qdoc3 (partially), and ECMA-334 (C# spec.) compatible. +<li>Comes with a GUI frontend (Doxywizard) to ease editing the options and run doxygen. + The GUI is available on Windows, Linux, and MacOSX. <li>Automatically generates class and collaboration diagrams in HTML (as clickable image maps) and \f$\mbox{\LaTeX}\f$ (as Encapsulated PostScript images). <li>Uses the dot tool of the Graphviz tool kit to generate include dependency graphs, collaboration diagrams, call graphs, directory structure graphs, and graphical class hierarchy graphs. +<li>Allows grouping of entities in modules and creating a hierarchy of modules. <li>Flexible comment placement: Allows you to put documentation in the header file (before the declaration of an entity), source file (before the definition of an entity) or in a separate file. <li>Generates a list of all members of a class (including any inherited members) along with their protection level. -<li>Outputs documentation in on-line format (HTML and UNIX man page) and +<li>Outputs documentation in on-line format (XHTML and UNIX man page) and off-line format (\f$\mbox{\LaTeX}\f$ and RTF) simultaneously (any of these can be disabled if desired). All formats are optimized for ease of reading. <br> Furthermore, compressed HTML can be generated from HTML output using Microsoft's HTML Help Workshop (Windows only) and PDF can be generated from the \f$\mbox{\LaTeX}\f$ output. +<li>Support for various third party help formats including HTML Help, + docsets, Qt-Help, and eclipse help. <li>Includes a full C preprocessor to allow proper parsing of conditional code fragments and to allow expansion of all or part of macros definitions. <li>Automatically detects public, protected and private sections, as well as @@ -56,12 +67,14 @@ <li>References to base/super classes and inherited/overridden members are generated automatically. <li>Includes a fast, rank based search engine to search for strings or words - in the class and member documentation. + in the class and member documentation (PHP based). +<li>Includes an Javascript based live search feature to search for symbols + as you type (for small to medium sized projects). <li>You can type normal HTML tags in your documentation. Doxygen will convert them to their equivalent \f$\mbox{\LaTeX}\f$, RTF, and man-page counterparts automatically. -<li>Allows references to documentation generated for other projects - (or another part of the same project) in a location independent way. +<li>Allows references to documentation generated for other (doxygen documented) + projects (or another part of the same project) in a location independent way. <li>Allows inclusion of source code examples that are automatically cross-referenced with the documentation. <li>Inclusion of undocumented classes is also supported, allowing to quickly @@ -75,6 +88,11 @@ configuration file. <li>Documentation and search engine can be transferred to another location or machine without regenerating the documentation. +<li>Supports many different character encodings and uses UTF-8 internally and + for the generated output. +<li>Doxygen can generate a layout which you can use and edit to change the + layout of each page. +<li>There more than a 100 configurable options to finetune the output. <li>Can cope with large projects easily. </UL> diff --git a/doc/index.doc b/doc/index.doc index 8633331..c36504d 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -87,8 +87,6 @@ The second part forms a reference manual: <ul> <li>Section \ref features presents an overview of what doxygen can do. -<li>Section \ref history shows what has changed during the development - of doxygen and what still has to be done. <li>Section \ref doxygen_usage shows how to use the \c doxygen program. <li>Section \ref doxytag_usage shows how to use the \c doxytag program. <li>Section \ref doxywizard_usage shows how to use the \c doxywizard program. diff --git a/doc/language.doc b/doc/language.doc index b61b9f4..c4c1e10 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -73,7 +73,7 @@ when the translator was updated. <tr bgcolor="#ffffff"> <td>Catalan</td> <td>Maximiliano Pin<br/>Albert Mora</td> - <td>max.pin at bitroit dot com<br/>[unreachable]</td> + <td>max dot pin at bitroit dot com<br/>[unreachable]</td> <td>1.6.3</td> </tr> <tr bgcolor="#ffffff"> @@ -85,20 +85,20 @@ when the translator was updated. <tr bgcolor="#ffffff"> <td>Chinese Traditional</td> <td>Daniel YC Lin<br/>Gary Lee</td> - <td>dlin.tw at gmail dot com<br/>garywlee at gmail dot com</td> + <td>dlin dot tw at gmail dot com<br/>garywlee at gmail dot com</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>Croatian</td> <td>Boris Bralo</td> - <td>boris.bralo at gmail dot com</td> + <td>boris dot bralo at gmail dot com</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Czech</td> <td>Petr Přikryl</td> <td>prikrylp at skil dot cz</td> - <td>1.6.3</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Danish</td> @@ -127,7 +127,7 @@ when the translator was updated. <tr bgcolor="#ffffff"> <td>Finnish</td> <td>Antti Laine</td> - <td>antti.a.laine at tut dot fi</td> + <td>antti dot a dot laine at tut dot fi</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> @@ -145,7 +145,7 @@ when the translator was updated. <tr bgcolor="#ffffff"> <td>Greek</td> <td>Paul Gessos</td> - <td>gessos.paul at yahoo dot gr</td> + <td>gessos dot paul at yahoo dot gr</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> @@ -212,12 +212,12 @@ when the translator was updated. <td>Persian</td> <td>Ali Nadalizadeh</td> <td>nadalizadeh at gmail dot com</td> - <td>1.6.0</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Polish</td> <td>Piotr Kaminski<br/>Grzegorz Kowal<br/>Krzysztof Kral</td> - <td>[unreachable]<br/>[unreachable]<br/>krzysztof.kral at gmail dot com</td> + <td>[unreachable]<br/>[unreachable]<br/>krzysztof dot kral at gmail dot com</td> <td>1.6.3</td> </tr> <tr bgcolor="#ffffff"> @@ -254,12 +254,12 @@ when the translator was updated. <td>Slovak</td> <td>-- searching for the maintainer --</td> <td></td> - <td>1.2.18</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Slovene</td> <td>Matjaž Ostroveršnik</td> - <td>matjaz.ostroversnik at ostri dot org</td> + <td>matjaz dot ostroversnik at ostri dot org</td> <td>1.4.6</td> </tr> <tr bgcolor="#ffffff"> @@ -301,111 +301,113 @@ when the translator was updated. \latexonly -\begin{tabular}{|l|l|l|l|} +\footnotesize +\begin{longtable}{|l|l|l|l|} \hline {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline \hline - Afrikaans & Johan Prinsloo & {\tt\tiny johan@zippysnoek.com} & 1.6.0 \\ + Afrikaans & Johan Prinsloo & {\tt\tiny johan at zippysnoek dot com} & 1.6.0 \\ \hline - Arabic & Moaz Reyad & {\tt\tiny moazreyad@yahoo.com} & 1.4.6 \\ + Arabic & Moaz Reyad & {\tt\tiny moazreyad at yahoo dot com} & 1.4.6 \\ \hline - Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino@uol.com.br} & up-to-date \\ + Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino at uol dot com dot br} & up-to-date \\ \hline - Catalan & Maximiliano Pin & {\tt\tiny max.pin@bitroit.com} & 1.6.3 \\ - ~ & Albert Mora & {\tt\tiny [unreachable] amora@iua.upf.es} & ~ \\ + Catalan & Maximiliano Pin & {\tt\tiny max dot pin at bitroit dot com} & 1.6.3 \\ + ~ & Albert Mora & {\tt\tiny [unreachable] amora at iua dot upf dot es} & ~ \\ \hline - Chinese & Li Daobing & {\tt\tiny lidaobing@gmail.com} & 1.6.0 \\ - ~ & Wei Liu & {\tt\tiny liuwei@asiainfo.com} & ~ \\ + Chinese & Li Daobing & {\tt\tiny lidaobing at gmail dot com} & 1.6.0 \\ + ~ & Wei Liu & {\tt\tiny liuwei at asiainfo dot com} & ~ \\ \hline - Chinese Traditional & Daniel YC Lin & {\tt\tiny dlin.tw@gmail.com} & 1.6.0 \\ - ~ & Gary Lee & {\tt\tiny garywlee@gmail.com} & ~ \\ + Chinese Traditional & Daniel YC Lin & {\tt\tiny dlin dot tw at gmail dot com} & 1.6.0 \\ + ~ & Gary Lee & {\tt\tiny garywlee at gmail dot com} & ~ \\ \hline - Croatian & Boris Bralo & {\tt\tiny boris.bralo@gmail.com} & up-to-date \\ + Croatian & Boris Bralo & {\tt\tiny boris dot bralo at gmail dot com} & up-to-date \\ \hline - Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & 1.6.3 \\ + Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp at skil dot cz} & up-to-date \\ \hline - Danish & Erik S\o{}e S\o{}rensen & {\tt\tiny eriksoe+doxygen@daimi.au.dk} & 1.5.4 \\ + Danish & Erik S\o{}e S\o{}rensen & {\tt\tiny eriksoe+doxygen at daimi dot au dot dk} & 1.5.4 \\ \hline - Dutch & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\ + Dutch & Dimitri van Heesch & {\tt\tiny dimitri at stack dot nl} & up-to-date \\ \hline - English & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\ + English & Dimitri van Heesch & {\tt\tiny dimitri at stack dot nl} & up-to-date \\ \hline - Esperanto & Ander Martinez & {\tt\tiny dwarfnauko@gmail.com} & 1.6.3 \\ + Esperanto & Ander Martinez & {\tt\tiny dwarfnauko at gmail dot com} & 1.6.3 \\ \hline - Finnish & Antti Laine & {\tt\tiny antti.a.laine@tut.fi} & 1.6.0 \\ + Finnish & Antti Laine & {\tt\tiny antti dot a dot laine at tut dot fi} & 1.6.0 \\ \hline - French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & 1.6.3 \\ + French & Xavier Outhier & {\tt\tiny xouthier at yahoo dot fr} & 1.6.3 \\ \hline - German & Jens Seidel & {\tt\tiny jensseidel@users.sf.net} & 1.6.3 \\ + German & Jens Seidel & {\tt\tiny jensseidel at users dot sf dot net} & 1.6.3 \\ \hline - Greek & Paul Gessos & {\tt\tiny gessos.paul@yahoo.gr} & up-to-date \\ + Greek & Paul Gessos & {\tt\tiny gessos dot paul at yahoo dot gr} & up-to-date \\ \hline - Hungarian & \'{A}kos Kiss & {\tt\tiny akiss@users.sourceforge.net} & 1.4.6 \\ - ~ & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt\tiny [unreachable] foldvari lost@cyberspace} & ~ \\ + Hungarian & \'{A}kos Kiss & {\tt\tiny akiss at users dot sourceforge dot net} & 1.4.6 \\ + ~ & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt\tiny [unreachable] foldvari lost at cyberspace} & ~ \\ \hline - Indonesian & Hendy Irawan & {\tt\tiny ceefour@gauldong.net} & 1.4.6 \\ + Indonesian & Hendy Irawan & {\tt\tiny ceefour at gauldong dot net} & 1.4.6 \\ \hline - Italian & Alessandro Falappa & {\tt\tiny alessandro@falappa.net} & 1.6.0 \\ - ~ & Ahmed Aldo Faisal & {\tt\tiny aaf23@cam.ac.uk} & ~ \\ + Italian & Alessandro Falappa & {\tt\tiny alessandro at falappa dot net} & 1.6.0 \\ + ~ & Ahmed Aldo Faisal & {\tt\tiny aaf23 at cam dot ac dot uk} & ~ \\ \hline - Japanese & Hiroki Iseri & {\tt\tiny goyoki@gmail.com} & 1.6.0 \\ - ~ & Ryunosuke Satoh & {\tt\tiny sun594@hotmail.com} & ~ \\ - ~ & Kenji Nagamatsu & {\tt\tiny naga@joyful.club.ne.jp} & ~ \\ - ~ & Iwasa Kazmi & {\tt\tiny [unreachable] iwasa@cosmo-system.jp} & ~ \\ + Japanese & Hiroki Iseri & {\tt\tiny goyoki at gmail dot com} & 1.6.0 \\ + ~ & Ryunosuke Satoh & {\tt\tiny sun594 at hotmail dot com} & ~ \\ + ~ & Kenji Nagamatsu & {\tt\tiny naga at joyful dot club dot ne dot jp} & ~ \\ + ~ & Iwasa Kazmi & {\tt\tiny [unreachable] iwasa at cosmo-system dot jp} & ~ \\ \hline JapaneseEn & see the Japanese language & {\tt\tiny ~} & English based \\ \hline - Korean & Kim Taedong & {\tt\tiny fly1004@gmail.com} & 1.6.3 \\ - ~ & SooYoung Jung & {\tt\tiny jung5000@gmail.com} & ~ \\ - ~ & Richard Kim & {\tt\tiny [unreachable] ryk@dspwiz.com} & ~ \\ + Korean & Kim Taedong & {\tt\tiny fly1004 at gmail dot com} & 1.6.3 \\ + ~ & SooYoung Jung & {\tt\tiny jung5000 at gmail dot com} & ~ \\ + ~ & Richard Kim & {\tt\tiny [unreachable] ryk at dspwiz dot com} & ~ \\ \hline KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\ \hline - Lithuanian & Tomas Simonaitis & {\tt\tiny [unreachable] haden@homelan.lt} & 1.4.6 \\ - ~ & Mindaugas Radzius & {\tt\tiny [unreachable] mindaugasradzius@takas.lt} & ~ \\ - ~ & Aidas Berukstis & {\tt\tiny [unreachable] aidasber@takas.lt} & ~ \\ + Lithuanian & Tomas Simonaitis & {\tt\tiny [unreachable] haden at homelan dot lt} & 1.4.6 \\ + ~ & Mindaugas Radzius & {\tt\tiny [unreachable] mindaugasradzius at takas dot lt} & ~ \\ + ~ & Aidas Berukstis & {\tt\tiny [unreachable] aidasber at takas dot lt} & ~ \\ ~ & -- contact lost -- & {\tt\tiny } & ~ \\ \hline - Macedonian & Slave Jovanovski & {\tt\tiny slavejovanovski@yahoo.com} & 1.6.0 \\ + Macedonian & Slave Jovanovski & {\tt\tiny slavejovanovski at yahoo dot com} & 1.6.0 \\ \hline - Norwegian & Lars Erik Jordet & {\tt\tiny lejordet@gmail.com} & 1.4.6 \\ + Norwegian & Lars Erik Jordet & {\tt\tiny lejordet at gmail dot com} & 1.4.6 \\ \hline - Persian & Ali Nadalizadeh & {\tt\tiny nadalizadeh@gmail.com} & 1.6.0 \\ + Persian & Ali Nadalizadeh & {\tt\tiny nadalizadeh at gmail dot com} & up-to-date \\ \hline - Polish & Piotr Kaminski & {\tt\tiny [unreachable] Piotr.Kaminski@ctm.gdynia.pl} & 1.6.3 \\ - ~ & Grzegorz Kowal & {\tt\tiny [unreachable] g\_kowal@poczta.onet.pl} & ~ \\ - ~ & Krzysztof Kral & {\tt\tiny krzysztof.kral@gmail.com} & ~ \\ + Polish & Piotr Kaminski & {\tt\tiny [unreachable] Piotr dot Kaminski at ctm dot gdynia dot pl} & 1.6.3 \\ + ~ & Grzegorz Kowal & {\tt\tiny [unreachable] g\_kowal at poczta dot onet dot pl} & ~ \\ + ~ & Krzysztof Kral & {\tt\tiny krzysztof dot kral at gmail dot com} & ~ \\ \hline - Portuguese & Rui Godinho Lopes & {\tt\tiny [unreachable] ruiglopes@yahoo.com} & 1.3.3 \\ + Portuguese & Rui Godinho Lopes & {\tt\tiny [unreachable] ruiglopes at yahoo dot com} & 1.3.3 \\ \hline - Romanian & Ionut Dumitrascu & {\tt\tiny reddumy@yahoo.com} & 1.6.0 \\ - ~ & Alexandru Iosup & {\tt\tiny aiosup@yahoo.com} & ~ \\ + Romanian & Ionut Dumitrascu & {\tt\tiny reddumy at yahoo dot com} & 1.6.0 \\ + ~ & Alexandru Iosup & {\tt\tiny aiosup at yahoo dot com} & ~ \\ \hline - Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & 1.6.0 \\ + Russian & Alexandr Chelpanov & {\tt\tiny cav at cryptopro dot ru} & 1.6.0 \\ \hline - Serbian & Dejan Milosavljevic & {\tt\tiny [unreachable] dmilos@email.com} & 1.6.0 \\ + Serbian & Dejan Milosavljevic & {\tt\tiny [unreachable] dmilos at email dot com} & 1.6.0 \\ \hline - SerbianCyrilic & Nedeljko Stefanovic & {\tt\tiny stenedjo@yahoo.com} & 1.6.0 \\ + SerbianCyrilic & Nedeljko Stefanovic & {\tt\tiny stenedjo at yahoo dot com} & 1.6.0 \\ \hline - Slovak & -- searching for the maintainer -- & {\tt\tiny } & 1.2.18 \\ + Slovak & -- searching for the maintainer -- & {\tt\tiny } & up-to-date \\ \hline - Slovene & Matja\v{z} Ostrover\v{s}nik & {\tt\tiny matjaz.ostroversnik@ostri.org} & 1.4.6 \\ + Slovene & Matja\v{z} Ostrover\v{s}nik & {\tt\tiny matjaz dot ostroversnik at ostri dot org} & 1.4.6 \\ \hline - Spanish & Bartomeu & {\tt\tiny bartomeu@loteria3cornella.com} & up-to-date \\ - ~ & Francisco Oltra Thennet & {\tt\tiny [unreachable] foltra@puc.cl} & ~ \\ - ~ & David Vaquero & {\tt\tiny david@grupoikusnet.com} & ~ \\ + Spanish & Bartomeu & {\tt\tiny bartomeu at loteria3cornella dot com} & up-to-date \\ + ~ & Francisco Oltra Thennet & {\tt\tiny [unreachable] foltra at puc dot cl} & ~ \\ + ~ & David Vaquero & {\tt\tiny david at grupoikusnet dot com} & ~ \\ \hline - Swedish & Mikael Hallin & {\tt\tiny mikaelhallin@yahoo.se} & 1.6.0 \\ + Swedish & Mikael Hallin & {\tt\tiny mikaelhallin at yahoo dot se} & 1.6.0 \\ \hline - Turkish & Emin Ilker Cetinbas & {\tt\tiny niw3@yahoo.com} & 1.6.0 \\ + Turkish & Emin Ilker Cetinbas & {\tt\tiny niw3 at yahoo dot com} & 1.6.0 \\ \hline Ukrainian & -- searching for the maintainer -- & {\tt\tiny } & 1.4.1 \\ \hline - Vietnamese & Dang Minh Tuan & {\tt\tiny tuanvietkey@gmail.com} & 1.6.0 \\ + Vietnamese & Dang Minh Tuan & {\tt\tiny tuanvietkey at gmail dot com} & 1.6.0 \\ \hline -\end{tabular} +\end{longtable} +\normalsize \endlatexonly diff --git a/doc/translator.py b/doc/translator.py index dd8fa00..14f8c3c 100644 --- a/doc/translator.py +++ b/doc/translator.py @@ -1910,13 +1910,15 @@ class TrManager: # Define templates for LaTeX table parts of the documentation. latexTableTpl = r''' \latexonly - \begin{tabular}{|l|l|l|l|} + \footnotesize + \begin{longtable}{|l|l|l|l|} \hline {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline %s \hline - \end{tabular} + \end{longtable} + \normalsize \endlatexonly ''' latexTableTpl = dedent(latexTableTpl) diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 9501c7d..6d1c243 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -10,7 +10,7 @@ Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese. -Of them, 6 translators are up-to-date, 32 translators are based on +Of them, 9 translators are up-to-date, 29 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -21,9 +21,12 @@ still may be some details listed even for them: TranslatorBrazilian TranslatorCroatian + TranslatorCzech TranslatorDutch TranslatorEnglish TranslatorGreek + TranslatorPersian -- The MAX_DOT_GRAPH_HEIGHT found in trLegendDocs() + TranslatorSlovak TranslatorSpanish -- The MAX_DOT_GRAPH_HEIGHT found in trLegendDocs() ---------------------------------------------------------------------- @@ -41,7 +44,6 @@ must be implemented to become up-to-date: Note: Reimplementation using UTF-8 suggested. TranslatorEsperanto 1.6.3 4 methods to implement (1 %) - TranslatorCzech 1.6.3 4 methods to implement (1 %) TranslatorCatalan 1.6.3 4 methods to implement (1 %) TranslatorVietnamese 1.6.0 9 methods to implement (4 %) TranslatorTurkish 1.6.0 9 methods to implement (4 %) @@ -58,9 +60,6 @@ must be implemented to become up-to-date: TranslatorRomanian 1.6.0 9 methods to implement (4 %) Note: Reimplementation using UTF-8 suggested. - TranslatorPersian 1.6.0 9 methods to implement (4 %) - Note: Reimplementation using UTF-8 suggested. - TranslatorMacedonian 1.6.0 9 methods to implement (4 %) TranslatorJapanese 1.6.0 9 methods to implement (4 %) Note: Reimplementation using UTF-8 suggested. @@ -103,9 +102,6 @@ must be implemented to become up-to-date: TranslatorPortuguese 1.3.3 44 methods to implement (19 %) Note: Reimplementation using UTF-8 suggested. - TranslatorSlovak 1.2.18 53 methods to implement (23 %) - Note: Reimplementation using UTF-8 suggested. - ---------------------------------------------------------------------- The following translator classes derive directly from the @@ -254,19 +250,6 @@ TranslatorChinesetraditional (TranslatorAdapter_1_6_0) 9 methods to implement virtual QCString trIncludesFileIn(const char * name) -TranslatorCzech (TranslatorAdapter_1_6_3) 4 methods to implement (1 %) ---------------- - - Implements 221 of the required methods (98 %). - - Missing methods (should be implemented): - - virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) - virtual QCString trFileIn(const char * name) - virtual QCString trDirDependency(const char * name) - virtual QCString trIncludesFileIn(const char * name) - - TranslatorDanish (TranslatorAdapter_1_5_4) 31 methods to implement (13 %) ---------------- @@ -661,22 +644,10 @@ TranslatorNorwegian (TranslatorAdapter_1_4_6) 32 methods to implement (14 %) virtual QCString trNoDescriptionAvailable() -TranslatorPersian (TranslatorAdapter_1_6_0) 9 methods to implement (4 %) +TranslatorPersian (Translator) ----------------- - Implements 216 of the required methods (96 %). - - Missing methods (should be implemented): - - virtual QCString trSearching() - virtual QCString trNoMatches() - virtual QCString trLoading() - virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) - virtual QCString trFileIn(const char * name) - virtual QCString trGlobalNamespace() - virtual QCString trDirRelation(const char * name) - virtual QCString trDirDependency(const char * name) - virtual QCString trIncludesFileIn(const char * name) + Implements 225 of the required methods (100 %). TranslatorPolish (TranslatorAdapter_1_6_3) 4 methods to implement (1 %) @@ -841,80 +812,6 @@ TranslatorSerbianCyrilic (TranslatorAdapter_1_6_0) 9 methods to implement (4 virtual QCString trIncludesFileIn(const char * name) -TranslatorSlovak (TranslatorAdapter_1_2_18) 53 methods to implement (23 %) ----------------- - - Implements 172 of the required methods (76 %). - - Missing methods (should be implemented): - - virtual QCString trCompoundMembersDescriptionFortran(bool extractAll) - virtual QCString trSearching() - virtual QCString trOverloadText() - virtual QCString trEventDocumentation() - virtual QCString trDirIndex() - virtual QCString trNoMatches() - virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single) - virtual QCString trLoading() - virtual QCString trSubprograms() - virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) - virtual QCString trPackageMembers() - virtual QCString trStaticPackageMembers() - virtual QCString trModulesListDescription(bool extractAll) - virtual QCString trModulesList() - virtual QCString trDirDocumentation() - virtual QCString trSearchResultsTitle() - virtual QCString trDirectories() - virtual QCString trTypeConstraints() - virtual QCString trFileIn(const char * name) - virtual QCString trGlobalNamespace() - virtual QCString trMemberFunctionDocumentationFortran() - virtual QCString trDirDescription() - virtual QCString trStaticPackageAttribs() - virtual QCString trCompoundListDescriptionFortran() - virtual QCString trCallGraph() - virtual QCString trTypeDocumentation() - virtual QCString trModuleReference(const char * namespaceName) - virtual QCString trModulesMemberDescription(bool extractAll) - virtual QCString trModulesMembers() - virtual QCString trModulesIndex() - virtual QCString trDirRelation(const char * name) - virtual QCString trPackageTypes() - virtual QCString trCompoundListFortran() - virtual QCString trDataTypes() - virtual QCString trSearchResults(int numDocuments) - virtual QCString trDirDependency(const char * name) - virtual QCString trIncludesFileIn(const char * name) - virtual QCString trPackageAttribs() - virtual QCString trSearchMatches() - virtual QCString trCompoundIndexFortran() - virtual QCString trSubprogram(bool first_capital, bool singular) - virtual QCString trEvents() - virtual QCString trCallerGraph() - virtual QCString trCompoundReferenceFortran(const char * clName, ClassDef::CompoundType compType, bool isTemplate) - virtual QCString trType(bool first_capital, bool singular) - virtual QCString trModule(bool first_capital, bool singular) - virtual QCString trCompoundMembersFortran() - virtual QCString trSourceFile(QCString & filename) - virtual QCString trDirReference(const char * dirName) - virtual QCString trDir(bool first_capital, bool singular) - virtual QCString trSearchForIndex() - virtual QCString trAll() - virtual QCString trSubprogramDocumentation() - - Obsolete methods (should be removed, never used): - - virtual QCString trHeaderFilesDescription() - virtual QCString trField(bool first_capital, bool singular) - virtual QCString trPackageDocumentation() - virtual QCString trSources() - virtual QCString trReimplementedForInternalReasons() - virtual QCString trInterfaces() - virtual QCString trHeaderFiles() - virtual QCString trBugsAndLimitations() - virtual QCString trNoDescriptionAvailable() - - TranslatorSlovene (TranslatorAdapter_1_4_6) 33 methods to implement (14 %) ----------------- |