diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.doc | 22 | ||||
| -rw-r--r-- | doc/docblocks.doc | 4 | ||||
| -rw-r--r-- | doc/language.doc | 30 | ||||
| -rw-r--r-- | doc/language.tpl | 4 | ||||
| -rw-r--r-- | doc/maintainers.txt | 5 | ||||
| -rw-r--r-- | doc/translator_report.txt | 84 | ||||
| -rw-r--r-- | doc/xmlcmds.doc | 2 |
7 files changed, 59 insertions, 92 deletions
diff --git a/doc/config.doc b/doc/config.doc index 6e0958a..8525593 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -1219,18 +1219,22 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" If the tag is left blank doxygen will generate a standard header. - The following commands have a special meaning inside the header: - <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>, - <code>\$doxygenversion</code>, <code>\$projectname</code>, and - <code>\$projectnumber</code>. - Doxygen will replace them by respectively - the title of the page, the current date and time, only the current date, - the version number of doxygen, the project name (see \c PROJECT_NAME), or the - project number (see \c PROJECT_NUMBER). - + The following markers have a special meaning inside the header and footer: + <dl> + <dt><code>\$title</code><dd>will be replaced with the title of the page. + <dt><code>\$datetime</code><dd>will be replaced with current the date and time. + <dt><code>\$date</code><dd>will be replaced with the current date. + <dt><code>\$year</code><dd>will be replaces with the current year. + <dt><code>\$doxygenversion</code><dd>will be replaced with the version of doxygen + <dt><code>\$projectname</code><dd>will be replaced with the name of + the project (see \c PROJECT_NAME) + <dt><code>\$projectnumber</code><dd>will be replaced with the project number + (see \c PROJECT_NUMBER) + <dt><code>\$relpath\$</code><dd> If \c CREATE_SUBDIRS is enabled, the command <code>\$relpath\$</code> can be used to produce a relative path to the root of the HTML output directory, e.g. use \$relpath\$doxygen.css, to refer to the standard style sheet. + </dl> See also section \ref doxygen_usage for information on how to generate the default header that doxygen normally uses. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 8ac55bb..ebbe879 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -70,7 +70,7 @@ In both cases the intermediate *'s are optional, so is also valid. -<li> A third alternative is to use a block of at least two C++ comment +<li> A third alternative is to use a block of <i>at least two</i> C++ comment lines, where each line starts with an additional slash or an exclamation mark. Here are examples of the two cases: @@ -88,6 +88,8 @@ or //! \endverbatim +Note that a blank line ends a documentation block in this case. + <li> Some people like to make their comment blocks more visible in the diff --git a/doc/language.doc b/doc/language.doc index e5e3774..884fce8 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,14 +23,15 @@ text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). -Currently (version 1.5.7.1), 37 languages +Currently (version 1.5.8), 38 languages are supported (sorted alphabetically): Afrikaans, Arabic, Brazilian Portuguese, Catalan, Chinese, Chinese -Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, -German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean -(+En), Lithuanian, Macedonian, Norwegian, Persian, Polish, Portuguese, -Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, -Swedish, Turkish, Ukrainian, and Vietnamese.. +Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, +Finnish, French, German, Greek, Hungarian, Indonesian, Italian, +Japanese (+En), Korean (+En), Lithuanian, Macedonian, Norwegian, +Persian, Polish, Portuguese, Romanian, Russian, Serbian, +SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, +and Vietnamese.. The table of information related to the supported languages follows. It is sorted by language alphabetically. The <b>Status</b> column @@ -118,6 +119,12 @@ when the translator was updated. <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> + <td>Esperanto</td> + <td>Ander Martinez</td> + <td>dwarfnauko at gmail dot com</td> + <td>up-to-date</td> + </tr> + <tr bgcolor="#ffffff"> <td>Finnish</td> <td>Antti Laine</td> <td>antti.a.laine at tut dot fi</td> @@ -223,7 +230,7 @@ when the translator was updated. <td>Romanian</td> <td>Ionut Dumitrascu<br>Alexandru Iosup</td> <td>reddumy at yahoo dot com<br>aiosup at yahoo dot com</td> - <td>1.4.1</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Russian</td> @@ -257,8 +264,8 @@ when the translator was updated. </tr> <tr bgcolor="#ffffff"> <td>Spanish</td> - <td>Bartomeu<br>Francisco Oltra Thennet</td> - <td>bartomeu at loteria3cornella dot com<br>foltra at puc dot cl</td> + <td>Bartomeu<br>Francisco Oltra Thennet<br>David Vaquero</td> + <td>bartomeu at loteria3cornella dot com<br>foltra at puc dot cl<br>david at grupoikusnet dot com</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> @@ -325,6 +332,8 @@ when the translator was updated. \hline English & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\ \hline + Esperanto & Ander Martinez & {\tt\tiny dwarfnauko@gmail.com} & up-to-date \\ + \hline Finnish & Antti Laine & {\tt\tiny antti.a.laine@tut.fi} & up-to-date \\ \hline French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & 1.5.4 \\ @@ -368,7 +377,7 @@ when the translator was updated. \hline Portuguese & Rui Godinho Lopes & {\tt\tiny ruiglopes@yahoo.com} & 1.3.3 \\ \hline - Romanian & Ionut Dumitrascu & {\tt\tiny reddumy@yahoo.com} & 1.4.1 \\ + Romanian & Ionut Dumitrascu & {\tt\tiny reddumy@yahoo.com} & up-to-date \\ ~ & Alexandru Iosup & {\tt\tiny aiosup@yahoo.com} & ~ \\ \hline Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & up-to-date \\ @@ -383,6 +392,7 @@ when the translator was updated. \hline Spanish & Bartomeu & {\tt\tiny bartomeu@loteria3cornella.com} & up-to-date \\ ~ & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & ~ \\ + ~ & David Vaquero & {\tt\tiny david@grupoikusnet.com} & ~ \\ \hline Swedish & Mikael Hallin & {\tt\tiny mikaelhallin@yahoo.se} & 1.4.6 \\ \hline diff --git a/doc/language.tpl b/doc/language.tpl index f15fa00..ca1900e 100644 --- a/doc/language.tpl +++ b/doc/language.tpl @@ -62,10 +62,10 @@ Just follow these steps: at two places in the script: <ol> <li>After the <code>f_langs=</code> is statement, in lower case. - <li>In the string that following <code>@allowed=</code> in upper case. + <li>In the string that following <code>\@allowed=</code> in upper case. </ol> The rerun the configure script such that is generates src/lang_cfg.h. -This file should now contain a #define for your language code. +This file should now contain a \#define for your language code. <li>Edit language.cpp: Add a \verbatim diff --git a/doc/maintainers.txt b/doc/maintainers.txt index 9c61314..c5f9f50 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -45,6 +45,9 @@ Dimitri van Heesch: dimitri@stack.nl TranslatorEnglish Dimitri van Heesch: dimitri@stack.nl +TranslatorEsperanto +Ander Martinez: dwarfnauko@gmail.com + TranslatorFinnish Antti Laine: antti.a.laine@tut.fi @@ -69,6 +72,7 @@ Alessandro Falappa: alessandro@falappa.net Ahmed Aldo Faisal: aaf23@cam.ac.uk TranslatorJapanese +Hiroki Iseri: goyoki@gmail.com Ryunosuke Satoh: sun594@hotmail.com Kenji Nagamatsu: naga@joyful.club.ne.jp Iwasa Kazmi: iwasa@cosmo-system.jp @@ -121,6 +125,7 @@ Matjaž Ostroveršnik: matjaz.ostroversnik@ostri.org TranslatorSpanish Bartomeu: bartomeu@loteria3cornella.com Francisco Oltra Thennet: foltra@puc.cl +David Vaquero: david@grupoikusnet.com TranslatorSwedish Mikael Hallin: mikaelhallin@yahoo.se diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 9f1f670..771633d 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,15 +1,16 @@ -(1.5.7.1) +(1.5.8) -Doxygen supports the following 37 languages (sorted alphabetically): +Doxygen supports the following 38 languages (sorted alphabetically): Afrikaans, Arabic, Brazilian Portuguese, Catalan, Chinese, Chinese -Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, -German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean -(+En), Lithuanian, Macedonian, Norwegian, Persian, Polish, Portuguese, -Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, -Swedish, Turkish, Ukrainian, and Vietnamese. - -Of them, 20 translators are up-to-date, 17 translators are based on +Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, +Finnish, French, German, Greek, Hungarian, Indonesian, Italian, +Japanese (+En), Korean (+En), Lithuanian, Macedonian, Norwegian, +Persian, Polish, Portuguese, Romanian, Russian, Serbian, +SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, +and Vietnamese. + +Of them, 22 translators are up-to-date, 16 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -26,16 +27,18 @@ still may be some details listed even for them: TranslatorCzech TranslatorDutch TranslatorEnglish - TranslatorFinnish -- Change the base class to Translator. + TranslatorEsperanto + TranslatorFinnish TranslatorGerman TranslatorItalian TranslatorKorean TranslatorMacedonian TranslatorPersian + TranslatorRomanian TranslatorRussian TranslatorSerbianCyrilic TranslatorSerbian - TranslatorSpanish -- Change the base class to Translator. + TranslatorSpanish TranslatorTurkish TranslatorVietnamese @@ -59,7 +62,6 @@ must be implemented to become up-to-date: TranslatorArabic 1.4.6 23 methods to implement TranslatorAfrikaans 1.4.6 24 methods to implement TranslatorUkrainian 1.4.1 24 methods to implement - TranslatorRomanian 1.4.1 24 methods to implement TranslatorPortuguese 1.3.3 35 methods to implement TranslatorSlovak 1.2.18 44 methods to implement @@ -79,6 +81,7 @@ The situation should be checked. The .cpp files and .h files excluding the '*translator*' files in doxygen/src directory were simply searched for occurence of the method identifiers: + QCString trDCOPMethods() QCString trFunctionPrototypeDocumentation() @@ -195,12 +198,6 @@ TranslatorDanish (TranslatorAdapter_1_5_4) 22 methods to implement virtual QCString trSubprogramDocumentation() -TranslatorFinnish (TranslatorEnglish) ------------------ - - Implements 216 of the required methods. - - TranslatorFrench (TranslatorAdapter_1_5_4) 22 methods to implement ---------------- @@ -600,51 +597,6 @@ TranslatorPortuguese (TranslatorAdapter_1_3_3) 35 methods to implement QCString trNoDescriptionAvailable() -TranslatorRomanian (TranslatorAdapter_1_4_1) 24 methods to implement ------------------- - - Implements 192 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trCompoundMembersDescriptionFortran(bool extractAll) - virtual QCString trOverloadText() - virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single) - virtual QCString trSubprograms() - virtual QCString trModulesListDescription(bool extractAll) - virtual QCString trModulesList() - virtual QCString trTypeConstraints() - virtual QCString trMemberFunctionDocumentationFortran() - virtual QCString trCompoundListDescriptionFortran() - virtual QCString trTypeDocumentation() - virtual QCString trModuleReference(const char * namespaceName) - virtual QCString trModulesMemberDescription(bool extractAll) - virtual QCString trModulesMembers() - virtual QCString trModulesIndex() - virtual QCString trCompoundListFortran() - virtual QCString trDataTypes() - virtual QCString trCompoundIndexFortran() - virtual QCString trSubprogram(bool first_capital, bool singular) - 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 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() - - TranslatorSlovak (TranslatorAdapter_1_2_18) 44 methods to implement ---------------- @@ -743,12 +695,6 @@ TranslatorSlovene (TranslatorAdapter_1_4_6) 24 methods to implement virtual QCString trSubprogramDocumentation() -TranslatorSpanish (TranslatorAdapter_1_5_4) ------------------ - - Implements 216 of the required methods. - - TranslatorSwedish (TranslatorAdapter_1_4_6) 24 methods to implement ----------------- diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc index 7fdf034..40c1f30 100644 --- a/doc/xmlcmds.doc +++ b/doc/xmlcmds.doc @@ -51,7 +51,7 @@ Here is the list of tags supported by doxygen: <li><tt>\<paramref name="paramName"\></tt> Refers to a parameter with name "paramName". Similar to using \ref cmda "\\a". <li><tt>\<permission\></tt> Identifies the security accessibility of a member. - Ignored by doygen. + Ignored by doxygen. <li><tt>\<remarks\></tt> Identifies the detailed description. <li><tt>\<returns\></tt> Marks a piece of text as the return value of a function or method. Similar to using \ref cmdreturn "\\return". |