diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/autolink.doc | 6 | ||||
| -rw-r--r-- | doc/commands.doc | 9 | ||||
| -rw-r--r-- | doc/config.doc | 27 | ||||
| -rw-r--r-- | doc/docblocks.doc | 4 | ||||
| -rw-r--r-- | doc/language.doc | 2 | ||||
| -rw-r--r-- | doc/translator.py | 34 | ||||
| -rw-r--r-- | doc/translator_report.txt | 60 |
7 files changed, 118 insertions, 24 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index be64876..abd37b0 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -84,10 +84,10 @@ For non overloaded members the argument list may be omitted. If a function is overloaded and no matching argument list is specified - (i.e. pattern 2 or 5 is used), a link will be created to the + (i.e. pattern 2 or 6 is used), a link will be created to the documentation of one of the overloaded members. - For member functions the class scope (as used in patterns 4 to 6) may + For member functions the class scope (as used in patterns 4 to 7) may be omitted, if: <ol> <li>The pattern points to a documented member that belongs to the same class @@ -101,7 +101,7 @@ All of these entities can be linked to in the same way as described in the previous section. For sake of clarity it is advised to only use - patterns 3 and 6 in this case. + patterns 3 and 7 in this case. \par Example: \verbinclude autolink.cpp diff --git a/doc/commands.doc b/doc/commands.doc index 298f492..b1ce780 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -58,6 +58,7 @@ documentation: \refitem cmddef \\def \refitem cmddefgroup \\defgroup \refitem cmddeprecated \\deprecated +\refitem cmddetails \\details \refitem cmddir \\dir \refitem cmddontinclude \\dontinclude \refitem cmddot \\dot @@ -864,6 +865,14 @@ is empty, \c TEST, \c DEV, or \c DEV \c TEST. expected life span, etc. <hr> +\section cmddetails \\details {detailed decription} + + \addindex \\details + Just like \ref cmdbrief "\\brief" starts a brief description, \\details + starts the detailed description. You can also start a new paragraph (blank line) + then the \\details command is not needed. + +<hr> \section cmdelse \\else \addindex \\else diff --git a/doc/config.doc b/doc/config.doc index 8801aa1..16fe662 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -85,6 +85,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_dot_path DOT_PATH \refitem cfg_dot_transparent DOT_TRANSPARENT \refitem cfg_dotfile_dirs DOTFILE_DIRS +\refitem cfg_doxyfile_encoding DOXYFILE_ENCODING \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE \refitem cfg_enabled_sections ENABLED_SECTIONS @@ -178,6 +179,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_predefined PREDEFINED \refitem cfg_project_name PROJECT_NAME \refitem cfg_project_number PROJECT_NUMBER +\refitem cfg_qt_autobrief QT_AUTOBRIEF \refitem cfg_quiet QUIET \refitem cfg_recursive RECURSIVE \refitem cfg_referenced_by_relation REFERENCED_BY_RELATION @@ -226,9 +228,18 @@ followed by the descriptions of the tags grouped by category. \endsecreflist \section config_project Project related options -\anchor cfg_project_name +\anchor cfg_doxyfile_encoding <dl> +<dt>\c DOXYFILE_ENCODING <dd> + \addindex DOXYFILE_ENCODING + This tag specifies the encoding used for all characters in the config file that + follow. The default is UTF-8 which is also the encoding used for all text before + the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into + libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of + possible encodings. + +\anchor cfg_project_name <dt>\c PROJECT_NAME <dd> \addindex PROJECT_NAME The \c PROJECT_NAME tag is a single word (or a sequence of words @@ -382,7 +393,17 @@ followed by the descriptions of the tags grouped by category. If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the - Javadoc-style will behave just like the Qt-style comments. + Javadoc-style will behave just like regular Qt-style comments + (thus requiring an explicit \@brief command for a brief description.) + +\anchor cfg_qt_autobrief +<dt>\c QT_AUTOBRIEF <dd> + \addindex QT_AUTOBRIEF + If the \c QT_AUTOBRIEF is set to \c YES then doxygen + will interpret the first line (until the first dot) of a Qt-style + comment as the brief description. If set to NO (the default), the + Qt-style will behave just like regular Qt-style comments (thus + requiring an explicit \\brief command for a brief description.) \anchor cfg_builtin_stl_support <dt>\c BUILTIN_STL_SUPPORT <dd> @@ -753,6 +774,8 @@ function's detailed documentation block. If this tag is empty the current directory is searched. \anchor cfg_input_encoding +<dt>\c INPUT_ENCODING <dd> + \addindex INPUT_ENCODING This tag can be used to specify the character encoding of the source files that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index c0853cf..d5ff845 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -209,6 +209,10 @@ JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES: for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly +Similarly, if one wishes the first sentence of a Qt style documentation +block to automatically be treated as a brief description, one may set +\ref cfg_qt_autobrief "QT_AUTOBRIEF" to YES in the configuration file. + Unlike most other documentation systems, doxygen also allows you to put the documentation of members (including global functions) in front of the \e definition. This way the documentation can be placed in the source diff --git a/doc/language.doc b/doc/language.doc index c304eec..73875f5 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,7 +23,7 @@ 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.1-20070219), 33 languages +Currently (version 1.5.2), 33 languages are supported (sorted alphabetically): Afrikaans, Arabic, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, diff --git a/doc/translator.py b/doc/translator.py index 96ea736..af65706 100644 --- a/doc/translator.py +++ b/doc/translator.py @@ -48,6 +48,7 @@ 2005/02/28 - Slight modification to generate "mailto.txt" auxiliary file. 2005/08/15 - Doxygen's root directory determined primarily from DOXYGEN environment variable. When not found, then relatively to the script. + 2007/03/20 - The "translate me!" searched in comments and reported if found. """ from __future__ import generators @@ -156,17 +157,20 @@ class Transl: # Initialize the other collected information. self.classId = None self.baseClassId = None - self.readableStatus = None # 'up-to-date', '1.2.3', '1.3', etc. - self.status = None # '', '1.2.03', '1.3.00', etc. - self.lang = None # like 'Brasilian' - self.langReadable = None # like 'Brasilian Portuguese' - self.note = None # like 'should be cleaned up' - self.prototypeDic = {} # uniPrototype -> prototype - self.obsoleteMethods = None # list of prototypes to be removed - self.missingMethods = None # list of prototypes to be implemented + self.readableStatus = None # 'up-to-date', '1.2.3', '1.3', etc. + self.status = None # '', '1.2.03', '1.3.00', etc. + self.lang = None # like 'Brasilian' + self.langReadable = None # like 'Brasilian Portuguese' + self.note = None # like 'should be cleaned up' + self.prototypeDic = {} # uniPrototype -> prototype + self.translateMeText = 'translate me!' + self.translateMeFlag = False # comments with "translate me!" found + self.obsoleteMethods = None # list of prototypes to be removed + self.missingMethods = None # list of prototypes to be implemented self.implementedMethods = None # list of implemented required methods - self.adaptMinClass = None # The newest adapter class that can be used + self.adaptMinClass = None # The newest adapter class that can be used + def __tokenGenerator(self): """Generator that reads the file and yields tokens as 4-tuples. @@ -265,6 +269,12 @@ class Transl: sys.stderr.write(msg) yield (tokenId, tokenStr, tokenLineNo) + + # If it is a comment that contains the self.translateMeText + # string, set the flag -- the situation will be reported. + if tokenId == 'comment' and tokenStr.find(self.translateMeText) >= 0: + self.translateMeFlag = True + tokenId = None tokenStr = '' tokenLineNo = 0 @@ -1103,11 +1113,17 @@ class Transl: self.adaptMinClass = adaptMinClass self.readableStatus = adaptMinVersion # simplified + # If everything seems OK, but the explicit mark self.translateMeText + # in comments was found, something must be translated. + if not self.note and self.status == '' and self.translateMeFlag: + self.note = 'The "%s" found in a comment.' % self.translateMeText + # If everything seems OK, but there are obsolete methods, set # the note to clean-up source. This note will be used only when # the previous code did not set another note (priority). if not self.note and self.status == '' and self.obsoleteMethods: self.note = 'Remove the obsolete methods (never used).' + def report(self, fout): """Returns the report part for the source as a multiline string. diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 2b351ed..9bbad71 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.5.1-20070219) +(1.5.2) Doxygen supports the following 33 languages (sorted alphabetically): @@ -17,20 +17,20 @@ alphabetically). This means that they derive from the Translator class and they implement all 194 of the required methods. Anyway, there still may be some details listed even for them: - TranslatorBrazilian + TranslatorBrazilian -- The "translate me!" found in a comment. TranslatorCatalan - TranslatorChinese - TranslatorCroatian + TranslatorChinese -- The "translate me!" found in a comment. + TranslatorCroatian -- The "translate me!" found in a comment. TranslatorCzech - TranslatorDanish + TranslatorDanish -- The "translate me!" found in a comment. TranslatorDutch TranslatorEnglish TranslatorFrench - TranslatorGerman - TranslatorGreek -- Remove the obsolete methods (never used). - TranslatorItalian + TranslatorGerman -- The "translate me!" found in a comment. + TranslatorGreek -- The "translate me!" found in a comment. + TranslatorItalian -- The "translate me!" found in a comment. TranslatorJapanese -- Remove the obsolete methods (never used). - TranslatorRussian + TranslatorRussian -- The "translate me!" found in a comment. TranslatorSpanish ---------------------------------------------------------------------- @@ -105,6 +105,18 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 1 method to implement virtual QCString trNoDescriptionAvailable() +TranslatorBrazilian (Translator) +------------------- + + Implements 194 of the required methods. + + +TranslatorChinese (Translator) +----------------- + + Implements 194 of the required methods. + + TranslatorChinesetraditional (TranslatorAdapter_1_4_6) 1 method to implement ---------------------------- @@ -127,6 +139,18 @@ TranslatorChinesetraditional (TranslatorAdapter_1_4_6) 1 method to implement virtual QCString trNoDescriptionAvailable() +TranslatorCroatian (Translator) +------------------ + + Implements 194 of the required methods. + + +TranslatorDanish (Translator) +---------------- + + Implements 194 of the required methods. + + TranslatorFinnish (TranslatorEnglish) 96 methods to implement ----------------- @@ -243,6 +267,12 @@ TranslatorFinnish (TranslatorEnglish) 96 methods to implement QCString trNoDescriptionAvailable() +TranslatorGerman (Translator) +---------------- + + Implements 194 of the required methods. + + TranslatorGreek (Translator) --------------- @@ -294,6 +324,12 @@ TranslatorIndonesian (TranslatorAdapter_1_4_6) 1 method to implement virtual QCString trNoDescriptionAvailable() +TranslatorItalian (Translator) +----------------- + + Implements 194 of the required methods. + + TranslatorJapanese (Translator) ------------------ @@ -485,6 +521,12 @@ TranslatorRomanian (TranslatorAdapter_1_4_1) 2 methods to implement virtual QCString trNoDescriptionAvailable() +TranslatorRussian (Translator) +----------------- + + Implements 194 of the required methods. + + TranslatorSerbian (TranslatorAdapter_1_4_1) 2 methods to implement ----------------- |