diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 70 | ||||
| -rw-r--r-- | doc/config.doc | 45 | ||||
| -rw-r--r-- | doc/docblocks.doc | 16 | ||||
| -rw-r--r-- | doc/language.doc | 8 | ||||
| -rw-r--r-- | doc/translator_report.txt | 82 |
5 files changed, 121 insertions, 100 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index f61022a..7450d91 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -83,6 +83,7 @@ documentation: \refitem cmdenum \\enum \refitem cmdexample \\example \refitem cmdexception \\exception +\refitem cmdextends \\extends \refitem cmdfdollar \\f\$ \refitem cmdfbropen \\f[ \refitem cmdfbrclose \\f] @@ -97,6 +98,7 @@ documentation: \refitem cmdif \\if \refitem cmdifnot \\ifnot \refitem cmdimage \\image +\refitem cmdimplements \\implements \refitem cmdinclude \\include \refitem cmdincludelineno \\includelineno \refitem cmdingroup \\ingroup @@ -109,6 +111,7 @@ documentation: \refitem cmdlink \\link \refitem cmdmainpage \\mainpage \refitem cmdmanonly \\manonly +\refitem cmdmemberof \\memberof \refitem cmdmsc \\msc \refitem cmdn \\n \refitem cmdname \\name @@ -372,6 +375,23 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdinclude "\\include". <hr> +\section cmdextends \\extends <name> + + \addindex \\extends + This command can be used to manually indicate an inheritance relation, + when the programming language does not support this concept natively + (e.g. C). + + The file \c manual.c in the example directory shows how to use this command. + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + + \sa section \ref cmdimplements "\\implements" and section + \ref cmdmemberof "\\memberof" + +<hr> \section cmdfile \\file [<name>] \addindex \\file @@ -456,6 +476,23 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdshowinitializer "\\showinitializer". <hr> +\section cmdimplements \\implements <name> + + \addindex \\implements + This command can be used to manually indicate an inheritance relation, + when the programming language does not support this concept natively + (e.g. C). + + The file \c manual.c in the example directory shows how to use this command. + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + + \sa section \ref cmdextends "\\extends" and section + \ref cmdmemberof "\\memberof" + +<hr> \section cmdingroup \\ingroup (<groupname> [<groupname> <groupname>]) \addindex \\ingroup @@ -530,15 +567,36 @@ doxygen. Unrecognized commands are treated as normal text. section \ref cmdpage "\\page". <hr> +\section cmdmemberof \\memberof <name> + + \addindex \\memberof + This command make a function a member of a class in a similar way + as \ref cmdrelates "\\relates" does, only with this command the function + is represented as a real member of the class. + This can be useful when the programming language does not support + the concept of member functions natively (e.g. C). + + The file \c manual.c in the example directory shows how to use this command. + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + + \sa section \ref cmdextends "\\extends" and section + \ref cmdmemberof "\\memberof" + +<hr> \section cmdname \\name (header) -This command turns a comment block into a header -definition of a member group. The -comment block should be followed by a -<code>//\@{ ... //\@}</code> block containing the -members of the group. + \addindex \\name + + This command turns a comment block into a header + definition of a member group. The + comment block should be followed by a + <code>//\@{ ... //\@}</code> block containing the + members of the group. -See section \ref memgroup for an example. + See section \ref memgroup for an example. <hr> \section cmdnamespace \\namespace <name> diff --git a/doc/config.doc b/doc/config.doc index 1f3905a..31ff5a4 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -90,6 +90,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_dot_transparent DOT_TRANSPARENT \refitem cfg_dotfile_dirs DOTFILE_DIRS \refitem cfg_doxyfile_encoding DOXYFILE_ENCODING +\refitem cfg_doxygen2qthelp_loc DOXYGEN2QTHELP_LOC \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE \refitem cfg_enabled_sections ENABLED_SECTIONS @@ -192,6 +193,8 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_project_name PROJECT_NAME \refitem cfg_project_number PROJECT_NUMBER \refitem cfg_qt_autobrief QT_AUTOBRIEF +\refitem cfg_qthelp_config QTHELP_CONFIG +\refitem cfg_qthelp_file QTHELP_FILE \refitem cfg_quiet QUIET \refitem cfg_recursive RECURSIVE \refitem cfg_referenced_by_relation REFERENCED_BY_RELATION @@ -222,6 +225,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_strip_from_inc_path STRIP_FROM_INC_PATH \refitem cfg_strip_from_path STRIP_FROM_PATH \refitem cfg_subgrouping SUBGROUPING +\refitem cfg_symbol_cache_size SYMBOL_CACHE_SIZE \refitem cfg_tab_size TAB_SIZE \refitem cfg_tagfiles TAGFILES \refitem cfg_template_relations TEMPLATE_RELATIONS @@ -569,6 +573,23 @@ sources. Doxygen will then generate output that is tailored for VHDL. be useful for C code in case the coding convention dictates that all compound types are typedef'ed and only the typedef is referenced, never the tag name. +\anchor cfg_symbol_cache_size +<dt>\c SYMBOL_CACHE_SIZE <dd> + \addindex SYMBOL_CACHE_SIZE + The \c SYMBOL_CACHE_SIZE determines the size of the internal cache use to + determine which symbols to keep in memory and which to flush to disk. + When the cache is full, less often used symbols will be written to disk. + For small to medium size projects (<1000 input files) the default value is + probably good enough. For larger projects a too small cache size can cause + doxygen to be busy swapping symbols to and from disk most of the time + causing a significant performance penality. + If the system has enough physical memory increasing the cache will improve the + performance by keeping more symbols in memory. Note that the value works on + a logarithmic scale so increasing the size by one will rougly double the + memory usage. The cache size is given by this formula: + \f$2^{(16+\mbox{SYMBOL\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0, + corresponding to a cache size of \f$2^{16} = 65536\f$ symbols. + </dl> \section config_build Build related options @@ -1302,9 +1323,31 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \addindex HHC_LOCATION If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c HHC_LOCATION tag can be used to specify the location (absolute path including file name) of - the HTML help compiler (hhc.exe). If non empty doxygen will try to run + the HTML help compiler (hhc.exe). If non-empty doxygen will try to run the HTML help compiler on the generated index.hhp. +\anchor cfg_qthelp_file +<dt>\c QTHELP_FILE <dd> + \addindex QTHELP_FILE + If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c QTHELP_FILE tag can + be used to specify the file name of the resulting .(qch|qhp) file. + You can add a path in front of the file if the result should not be + written to the html output directory. + +\anchor cfg_qthelp_config +<dt>\c QTHELP_CONFIG <dd> + \addindex QTHELP_CONFIG + If \c DOXYGEN2QTHELP_LOC is set, \c QTHELP_CONFIG must specify the file name + of a config file to pass to doxygen2qthelp. + +\anchor cfg_doxygen2qthelp_loc +<dt>\c DOXYGEN2QTHELP_LOC <dd> + \addindex DOXYGEN2QTHELP_LOC + If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c DOXYGEN2QTHELP_LOC tag + can be used to specify the location (absolute path including file name) of + the doxygen2qthelp tool. If non-empty doxygen will try to run doxygen2qthelp + on the generated index.hhp. + \anchor cfg_generate_chi <dt>\c GENERATE_CHI <dd> \addindex GENERATE_CHI diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 5ebdf7b..0e9f38e 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -166,23 +166,19 @@ for this case. </ol> -As you can see doxygen is quite flexible. The following however is -not legal +As you can see doxygen is quite flexible. If you have multiple +detailed descriptions, like in the following example: \verbatim //! Brief description, which is //! really a detailed description since it spans multiple lines. -/*! Oops, another detailed description! +/*! Another detailed description! */ \endverbatim -because doxygen only allows one brief and one detailed description. - -Furthermore, if there is one brief description before a declaration -and one before a definition of a code item, only the one before -the \e declaration will be used. If the same situation occurs for a -detailed description, the one before the \e definition is preferred -and the one before the declaration will be ignored. +They will be joined. Note that this is also the case if the descriptions +are at different places in the code! In this case the order will depend +on the order in which doxygen parses the code. Here is an example of a documented piece of C++ code using the Qt style: \include qtstyle.cpp diff --git a/doc/language.doc b/doc/language.doc index d991d65..bb6caeb 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -73,7 +73,7 @@ when the translator was updated. <td>Catalan</td> <td>Maximiliano Pin<br>Albert Mora</td> <td>max.pin at bitroit dot com<br>amora at iua dot upf dot es</td> - <td>1.5.4</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Chinese</td> @@ -235,7 +235,7 @@ when the translator was updated. <td>Serbian</td> <td>Dejan Milosavljevic</td> <td>dmilos at email dot com</td> - <td>1.4.1</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>SerbianCyrilic</td> @@ -294,7 +294,7 @@ when the translator was updated. \hline Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino@uol.com.br} & up-to-date \\ \hline - Catalan & Maximiliano Pin & {\tt\tiny max.pin@bitroit.com} & 1.5.4 \\ + Catalan & Maximiliano Pin & {\tt\tiny max.pin@bitroit.com} & up-to-date \\ ~ & Albert Mora & {\tt\tiny amora@iua.upf.es} & ~ \\ \hline Chinese & Li Daobing & {\tt\tiny lidaobing@gmail.com} & up-to-date \\ @@ -360,7 +360,7 @@ when the translator was updated. \hline Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & up-to-date \\ \hline - Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & 1.4.1 \\ + Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & up-to-date \\ \hline SerbianCyrilic & Nedeljko Stefanovic & {\tt\tiny stenedjo@yahoo.com} & up-to-date \\ \hline diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 8598404..4c6b192 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -9,7 +9,7 @@ German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, and Ukrainian. -Of them, 16 translators are up-to-date, 19 translators are based on +Of them, 18 translators are up-to-date, 17 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -19,6 +19,7 @@ and they implement all 216 of the required methods. Anyway, there still may be some details listed even for them: TranslatorBrazilian + TranslatorCatalan TranslatorChinesetraditional TranslatorChinese TranslatorCroatian @@ -33,6 +34,7 @@ still may be some details listed even for them: TranslatorPersian TranslatorRussian TranslatorSerbianCyrilic + TranslatorSerbian TranslatorSpanish -- Change the base class to Translator. ---------------------------------------------------------------------- @@ -45,7 +47,6 @@ must be implemented to become up-to-date: TranslatorGreek 1.5.4 22 methods to implement TranslatorFrench 1.5.4 22 methods to implement TranslatorDanish 1.5.4 22 methods to implement - TranslatorCatalan 1.5.4 22 methods to implement TranslatorSwedish 1.4.6 24 methods to implement TranslatorSlovene 1.4.6 24 methods to implement TranslatorPolish 1.4.6 23 methods to implement @@ -56,7 +57,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 - TranslatorSerbian 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 @@ -152,37 +152,6 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 23 methods to implement virtual QCString trNoDescriptionAvailable() -TranslatorCatalan (TranslatorAdapter_1_5_4) 22 methods to implement ------------------ - - Implements 194 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trCompoundMembersDescriptionFortran(bool extractAll) - 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 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() - - TranslatorDanish (TranslatorAdapter_1_5_4) 22 methods to implement ---------------- @@ -658,51 +627,6 @@ TranslatorRomanian (TranslatorAdapter_1_4_1) 24 methods to implement virtual QCString trNoDescriptionAvailable() -TranslatorSerbian (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 ---------------- |