diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/autolink.doc | 2 | ||||
| -rw-r--r-- | doc/commands.doc | 36 | ||||
| -rw-r--r-- | doc/config.doc | 4 | ||||
| -rw-r--r-- | doc/docblocks.doc | 2 | ||||
| -rw-r--r-- | doc/htmlcmds.doc | 6 | ||||
| -rw-r--r-- | doc/index.doc | 1 | ||||
| -rw-r--r-- | doc/install.doc | 2 | ||||
| -rw-r--r-- | doc/language.doc | 71 |
8 files changed, 90 insertions, 34 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index 5b69020..ee0cd09 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -115,7 +115,7 @@ typedef struct StructName TypeName \par Example: \verbinclude restypedef.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/restypedef/html/restypedef_cpp.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/restypedef/html/restypedef_8cpp.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly */ diff --git a/doc/commands.doc b/doc/commands.doc index 21f0b6e..bdbbbae 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -45,6 +45,7 @@ documentation: \endlatexonly <li> \refitem cmda \a <li> \refitem cmdaddindex \addindex +<li> \refitem cmdaddtogroup \addtogroup <li> \refitem cmdanchor \anchor <li> \refitem cmdarg \arg <li> \refitem cmdattention \attention @@ -148,6 +149,35 @@ Doxygen. Unrecognized commands are treated as normal text. Structural indicators \htmlonly --- </center>\endhtmlonly</h2> +\subsection cmdaddtogroup \addtogroup <name> + \addindex \addtogroup + Add extra documentation to a group \<name\> that was previously defined + using \\defgroup. This command can also be used to add a number of + entities to an existing group using \@{ and \@} like this: + +\verbatim + /*! \addtogroup mygrp + * Additional documentation for group `mygrp' + * @{ + */ + + /*! + * A function + */ + void func1() + { + } + + /*! Another function */ + void func2() + { + } + + /*! @} */ +\endverbatim + + See also \ref cmddefgroup "\\defgroup" and \ref cmdingroup "\\ingroup". + \subsection cmdclass \class <name> [<header-file>] [<header-name>] \addindex \class @@ -180,7 +210,7 @@ Doxygen. Unrecognized commands are treated as normal text. \par Example: \verbinclude define.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_h.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_8h.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -271,7 +301,7 @@ Doxygen. Unrecognized commands are treated as normal text. \par Example: \verbinclude file.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_h.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_8h.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -547,7 +577,7 @@ Public/Protected/Private/... section. \par Example: \verbinclude author.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_windowsnt.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_windows_n_t.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly diff --git a/doc/config.doc b/doc/config.doc index b819f53..b41c9af 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -758,10 +758,10 @@ followed by the descriptions of the tags grouped by category. doxygen generates three additional HTML index files: \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a project file that can be read by - <a href="http://msdn.microsoft.com/workshop/author/htmlhelp"> + <a href="http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download_main.htm"> Microsoft HTML help workshop</a> \latexonly - (see http://msdn.microsoft.com/workshop/author/htmlhelp) + (see http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download\_main.htm) \endlatexonly on Windows. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index d2df482..547e617 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -159,7 +159,7 @@ Here is an example of a C header named \c structcmd.h that is documented using structural commands: \verbinclude structcmd.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd_h.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd_8h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 6cc320c..7e7f4b6 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -64,10 +64,8 @@ documentation. Note that all attributes of a HTML tag are ignored <li>\c </OL> Ends a numbered item list. <li>\c <P> Starts a new paragraph. <li>\c </P> Does not generate any output. -<li>\c <PRE> starts a code fragment, - equivalent to the command \\code (see section \ref cmdcode). -<li>\c </PRE> ends a code fragment, - equivalent to the command \\endcode (see section \ref cmdendcode). +<li>\c <PRE> starts a preformatted fragment. +<li>\c </PRE> ends a preformatted fragment. <li>\c <SMALL> starts a section of text displayed in a smaller font. <li>\c </SMALL> ends a \c <SMALL> section. <li>\c <STRONG> starts a section of bold text. diff --git a/doc/index.doc b/doc/index.doc index 9c89f8b..cb1b9c3 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -159,6 +159,7 @@ Thanks go to: <li>My brother <a href="http://www.stack.nl/~fidget/index.html">Frank</a> for rendering the logos. <li>Harm van der Heijden for adding HTML help support. +<li>Wouter Slegers for registering the www.doxygen.org domain. <li>Parker Waerchter for adding the RTF output generator. <li>Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator. diff --git a/doc/install.doc b/doc/install.doc index 52011a9..70d625a 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -425,7 +425,7 @@ Here is what is required: (see \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the config file, then you need the Microsoft HTML help workshop. You can download it at: - http://msdn.microsoft.com/workshop/author/htmlhelp + http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download_main.htm <li>If you used WinZip to extract the tar archive it will (apparently) not create empty folders, so you have to add the folders diff --git a/doc/language.doc b/doc/language.doc index d7b3a53..41e346e 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -18,13 +18,12 @@ <h3>Support for multiple languages</h3> -Doxygen has support for multiple languages. This means that the text fragments that -doxygen generates can changed into languages other than English -(the default) at configuration time. +Doxygen has support for multiple languages. This means +that the text fragments that doxygen generates can changed into languages +other than English (the default) at configuration time. <p> -Currently, supported languages are English, French, Czech, Dutch, Spannish, -Swedish, Russian, Czech, Croatian, Italian, Hungarian, Finnish, German and Japanese, -and Korean. +Currently, supported for over 20 languages is available. + Here is a list of the languages and their current maintainers: <p> @@ -269,7 +268,7 @@ let them (or me) know. If you want to add support for a language that is not yet listed please see the next section. -<h3>Language HOWTO</h3> +<h3>Adding a new language to doxygen</h3> This short HOWTO explains how to add support for a new language to Doxygen: @@ -278,7 +277,7 @@ Just follow these steps: <li>Tell me for which language you want to add support. If no one else is already working on support for that language, you will be assigned as the maintainer for the language. -<li>Create a copy of translator_nl.h and name it +<li>Create a copy of translator_en.h and name it translator_<your_2_letter_counter_code>.h I'll use xx in the rest of this document. <li>Edit language.cpp: @@ -294,35 +293,63 @@ Just follow these steps: } \endverbatim after the <code>if { ... }</code> -<li>Edit doxygen.pro and add \c translator_xx.h to +<li>Edit libdoxygen.pro.in and add \c translator_xx.h to the \c HEADERS line in the file doxygen.pro. <li>Edit <code>translator_xx.h</code>: <ul> - <li>Rename <code>TRANSLATOR_NL_H</code> to <code>TRANSLATOR_XX_H</code> twice. - <li>Rename TranslatorDutch to TranslatorYourLanguage - <li>In the member <code>latexBabelPackage()</code> change "dutch" into the name of the - latex package that adds support for your language. - <li>Edit all the strings that are returned by the members that start - with tr. - Look at the corresponding member in translator.h for the english text - that is returned and translate that into your language. + <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> twice. + <li>Rename TranslatorEnglish to TranslatorYourLanguage + <li>In the member <code>idLanguage()</code> change "english" into the + name of the your language (use lower case characters only). Depending + on the language you may also wish to change the member functions + latexLanguageSupportCommand() and idLanguageCharset(). + <li>Edit all the strings that are returned by the member functions that + start with tr. Try to match punctuation and capitals! To enter special characters (with accents) you can: <ul> <li> Enter them directly if your keyboard supports that and you are using a Latin-1 font. Doxygen will translate the characters to proper Latex and - leave the Html and man output for what it is. + leave the Html and man output for what it is (which is fine, if + idLanguageCharset() is set correctly). <li> Use html codes like \ä for an a with an umlaut (i.e. ä). See the HTML specification for the codes. </ul> </ul> -<li>Recompile everything (do this from the root of the distribution, - because the Makefile.dox* have to be regenerated!) +<li>Run configure and make again from the root of the distribution, + in order to regenerated the Makefiles. <li>Now you can use <code>OUTPUT_LANGUAGE = your_language_name</code> in the config file to generate output in your language. -<li>Send <code>translator_xx.h</code> or a <code>diff -u</code> of the changes - to me so I can add it to doxygen. +<li>Send <code>translator_xx.h</code> to me so I can add it to doxygen. </ol> + +<h3>Maintaining a language</h3> + +As new versions of doxygen appear, new sentences will be +added to the Translator interface class. Of course these need to be translated +as well (otherwise doxygen wouldn't even compile!). + +Waiting until all language maintainers have translated these new sentences +and sent the results would not be very practical for me. + +Instead, a new class TranslatorAdapter_x_y_z will be added to +translator_adapter.h (here x,y, and z correspond to the current +version of doxygen). And all translators that previous derived from +Translator will now derive from this adapter class. + +The Adapter class contains the new sentences with +default translations using the English translator (which is always up to date). +Instead of deriving your TranslatorXX class directly from Translator it will +derive from the intermediate class TranslatorAdapter_x_y_z. + +Thus, if a translator class inherits from a adapter class +maintenance is needed. By looking at the adapter class itself (and its base +classes) you can easily see which methods need to be updated. + +To update a language simply make your translator class derive from +TranslatorAdapterBase and provide translations for the methods that +were previously provided by the adapter class (and its base classes). + */ |