diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 15 | ||||
| -rw-r--r-- | doc/config.doc | 12 | ||||
| -rw-r--r-- | doc/formulas.doc | 2 | ||||
| -rw-r--r-- | doc/index.doc | 1 | ||||
| -rw-r--r-- | doc/language.doc | 9 | ||||
| -rw-r--r-- | doc/translator_report.txt | 23 | ||||
| -rw-r--r-- | doc/trouble.doc | 16 |
7 files changed, 45 insertions, 33 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 9cf21d4..de3cf0a 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -84,6 +84,8 @@ documentation: \refitem cmdfdollar \\f\$ \refitem cmdfbropen \\f[ \refitem cmdfbrclose \\f] +\refitem cmdfcurlyopen \\f{ +\refitem cmdfcurlyclose \\f} \refitem cmdfile \\file \refitem cmdfn \\fn \refitem cmdhideinitializer \\hideinitializer @@ -1975,6 +1977,19 @@ class Receiver \sa section \ref cmdfbropen "\\f[" and section \ref formulas "formulas". <hr> +\section cmdfcurlyopen \\f{environment}{ + + Marks the start of a formula that is in a specific environment. + \note The second \{ is optional and is only to help editors (such as Vim) to + do proper syntax highlighting by making the number of opening and closing braces + the same. + +<hr> +\section cmdfcurlyclose \\f} + + Marks the end of a formula that is in a specific environment. + +<hr> \section cmdhtmlonly \\htmlonly \addindex \\htmlonly diff --git a/doc/config.doc b/doc/config.doc index cd69fc6..029583a 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -214,6 +214,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_template_relations TEMPLATE_RELATIONS \refitem cfg_toc_expand TOC_EXPAND \refitem cfg_treeview_width TREEVIEW_WIDTH +\refitem cfg_typedef_hides_struct TYPEDEF_HIDES_STRUCT \refitem cfg_uml_look UML_LOOK \refitem cfg_use_htags USE_HTAGS \refitem cfg_use_pdflatex USE_PDFLATEX @@ -522,6 +523,17 @@ followed by the descriptions of the tags grouped by category. \c NO to prevent subgrouping. Alternatively, this can be done per class using the \ref cmdnosubgrouping "\\nosubgrouping" command. +\anchor cfg_typedef_hides_struct +<dt>\c TYPEDEF_HIDES_STRUCT <dd> + \addindex TYPEDEF_HIDES_STRUCT + When \c TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is + documented as struct with the name of the typedef. So + <code>typedef struct TypeS {} TypeT</code>, will appear in the documentation as a struct + with name \c TypeT. When disabled the typedef will appear as a member of a file, + namespace, or class. And the struct will be named \c TypeS. This can typically + be useful for C code where the coding convention is that all structs are + typedef'ed and only the typedef is referenced never the struct's name. + </dl> \section config_build Build related options diff --git a/doc/formulas.doc b/doc/formulas.doc index f77a6f3..0e35932 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -75,7 +75,7 @@ There are three ways to include formulas in the documentation. the corresponding end command is \\f}. Here is an example for an equation array \verbatim - \f{eqnarray*} + \f{eqnarray*}{ g &=& \frac{Gm_2}{r^2} \\ &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\, \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ diff --git a/doc/index.doc b/doc/index.doc index c3e5c8a..25a58f1 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -175,6 +175,7 @@ Thanks go to: given me a good start in writing doxygen. <li>All people at Troll Tech, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-) +<li>Kevin McBride for maintaining the subversion reporsitory for doxygen. <li>My brother Frank for rendering the logos. <li>Harm van der Heijden for adding HTML help support. diff --git a/doc/language.doc b/doc/language.doc index 27e1101..df12e1c 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -172,9 +172,9 @@ when the translator was updated. </tr> <tr bgcolor="#ffffff"> <td>Korean</td> - <td>SooYoung Jung<br>Richard Kim</td> - <td>jung5000 at gmail dot com<br>ryk at dspwiz dot com</td> - <td>1.4.6</td> + <td>Kim Taedong<br>SooYoung Jung<br>Richard Kim</td> + <td>fly1004 at gmail dot com<br>jung5000 at gmail dot com<br>ryk at dspwiz dot com</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>KoreanEn</td> @@ -322,7 +322,8 @@ when the translator was updated. \hline JapaneseEn & see the Japanese language & {\tt\tiny ~} & English based \\ \hline - Korean & SooYoung Jung & {\tt\tiny jung5000@gmail.com} & 1.4.6 \\ + Korean & Kim Taedong & {\tt\tiny fly1004@gmail.com} & up-to-date \\ + ~ & SooYoung Jung & {\tt\tiny jung5000@gmail.com} & ~ \\ ~ & Richard Kim & {\tt\tiny ryk@dspwiz.com} & ~ \\ \hline KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\ diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 0246b5c..9222fd1 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -8,7 +8,7 @@ German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean (+En), Lithuanian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. -Of them, 15 translators are up-to-date, 18 translators are based on +Of them, 16 translators are up-to-date, 17 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -17,7 +17,7 @@ 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 -- The "translate me!" found in a comment. + TranslatorBrazilian TranslatorCatalan TranslatorChinese TranslatorCroatian -- The "translate me!" found in a comment. @@ -30,6 +30,7 @@ still may be some details listed even for them: TranslatorGreek -- The "translate me!" found in a comment. TranslatorItalian -- The "translate me!" found in a comment. TranslatorJapanese -- Remove the obsolete methods (never used). + TranslatorKorean TranslatorRussian -- The "translate me!" found in a comment. TranslatorSpanish @@ -45,7 +46,6 @@ must be implemented to become up-to-date: TranslatorPersian 1.4.6 1 method to implement TranslatorNorwegian 1.4.6 1 method to implement TranslatorLithuanian 1.4.6 2 methods to implement - TranslatorKorean 1.4.6 2 methods to implement TranslatorIndonesian 1.4.6 1 method to implement TranslatorHungarian 1.4.6 2 methods to implement TranslatorChinesetraditional 1.4.6 1 method to implement @@ -105,12 +105,6 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 1 method to implement virtual QCString trNoDescriptionAvailable() -TranslatorBrazilian (Translator) -------------------- - - Implements 194 of the required methods. - - TranslatorChinesetraditional (TranslatorAdapter_1_4_6) 1 method to implement ---------------------------- @@ -356,17 +350,6 @@ TranslatorJapaneseEn (TranslatorEnglish) 189 methods to implement virtual QCString latexLanguageSupportCommand() -TranslatorKorean (TranslatorAdapter_1_4_6) 2 methods to implement ----------------- - - Implements 192 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trCallerGraph() - virtual QCString trEnumerationValueDocumentation() - - TranslatorKoreanEn (TranslatorEnglish) 189 methods to implement ------------------ diff --git a/doc/trouble.doc b/doc/trouble.doc index 060a19b..343404b 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -89,11 +89,11 @@ know why. Bugs are tracked in GNOME's <a href="http://bugzilla.gnome.org">bugzilla</a> database. Before submitting a <a href="http://bugzilla.gnome.org/enter_bug.cgi?product=doxygen">new bug</a>, -first -<a href="http://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&bug_status=VERIFIED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&cmdtype=doit&namedcmd=gnome-libs+past+20+days&newqueryname=&order=Reuse+same+sort+as+last+time&form_name=query"> -check</a> if the same bug has already been submitted by others. +first <a href="http://bugzilla.gnome.org/query.cgi?format=advanced&product=doxygen">search</a> +through the database if the same bug has already been submitted by others (the doxygen +product will be preselected). If you believe you have found a new bug, -please <a href="http://bugzilla.gnome.org/enter_bug.cgi?product=doxygen">file it</a>. +please <a href="http://bugzilla.gnome.org/enter_bug.cgi?product=doxygen">report it</a>. If you are unsure whether or not something is a bug, please ask help on the <a href="http://sourceforge.net/mail/?group_id=5971">users mailing list</a> @@ -103,7 +103,7 @@ If you send only a (vague) description of a bug, you are usually not very helpful and it will cost me much more time to figure out what you mean. In the worst-case your bug report may even be completely ignored by me, so always try to include the following information in your bug report: -- The version of doxygen you are using (for instance 1.2.4, use +- The version of doxygen you are using (for instance 1.5.3, use <code>doxygen --version</code> if you are not sure). - The name and version number of your operating system (for instance SuSE Linux 6.4) @@ -112,14 +112,14 @@ always try to include the following information in your bug report: to keep it small (use <code>doxygen -s -u [configName]</code> to strip the comments from an existing config file). - The easiest (and often the only) way for me to fix bugs is if you can - send me a small example demonstrating the problem you have, so I can + attach a small example demonstrating the problem you have to the bug report, so I can reproduce it on my machine. Please make sure the example is valid source code (could potentially compile) and that the problem is really captured by the example (I often get examples that do not trigger the actual bug!). If you intend to send more than one file please zip or tar the files together into a single file for easier processing. - When reporting a new bug you'll get a chance to attach a file to it - immediately \e after opening the bug. + Note that when reporting a new bug you'll get a chance to attach a file to it + only \e after submitting the initial bug description. You can (and are encouraged to) add a patch for a bug. If you do so please use PATCH as a keyword in the bug entry form. |