diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2010-07-28 19:05:01 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2010-07-28 19:05:01 (GMT) |
commit | 4ad0d24c5b3a0afd99722ae5c33968ff9fa44e2d (patch) | |
tree | aa81c2bd3e6109417a6bd30d6a58111d892f25f2 /doc | |
parent | c37c8626674dd6ba0d53dcad84dd4bb5d92005a4 (diff) | |
download | Doxygen-4ad0d24c5b3a0afd99722ae5c33968ff9fa44e2d.zip Doxygen-4ad0d24c5b3a0afd99722ae5c33968ff9fa44e2d.tar.gz Doxygen-4ad0d24c5b3a0afd99722ae5c33968ff9fa44e2d.tar.bz2 |
Release-1.7.1-20100728
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 24 | ||||
-rw-r--r-- | doc/config.doc | 2 | ||||
-rw-r--r-- | doc/doxygen_manual.tex | 3 | ||||
-rw-r--r-- | doc/install.doc | 1 | ||||
-rw-r--r-- | doc/language.doc | 6 | ||||
-rw-r--r-- | doc/starting.doc | 16 | ||||
-rw-r--r-- | doc/translator_report.txt | 24 |
7 files changed, 41 insertions, 35 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index e8cf0a6..ed6f475 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -74,6 +74,7 @@ documentation: \refitem cmdenddot \\enddot \refitem cmdendhtmlonly \\endhtmlonly \refitem cmdendif \\endif +\refitem cmdendinternal \\endinternal \refitem cmdendlatexonly \\endlatexonly \refitem cmdendlink \\endlink \refitem cmdendmanonly \\endmanonly @@ -381,6 +382,15 @@ Structural indicators \sa section \ref cmdinclude "\\include". <hr> +\section cmdendinternal \\endinternal + + \addindex \\endinternal + This command ends a documentation fragment that was started with a + \ref cmdinternal "\\internal" command. The text between \c \\internal and + \c \\endinternal will only be visible + if \ref cfg_internal_docs "INTERNAL_DOCS" is set to YES. + +<hr> \section cmdextends \\extends <name> \addindex \\extends @@ -549,18 +559,18 @@ Structural indicators \section cmdinternal \\internal \addindex \\internal - This command writes the message `For internal use only' to the output and - all text \e after an \c \\internal command until the end of the - comment block or the end of the section (whichever comes first) is - marked as "internal". + This command starts a documentation fragment that is meant for internal + use only. The fragment naturally ends at the end of the comment block. + You can also force the internal section to end earlier using the + \ref cmdendinternal "\\endinternal" command. If the \\internal command is put inside a section - (see for example \ref cmdsection "\\section") all subsection after the + (see for example \ref cmdsection "\\section") all subsections after the command are considered to be internal as well. Only a new section at the - same level will be visible again. + same level will end the fragment that is considered internal. You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the config file - to show or hide the internal documentation. + to show (\c YES) or hide (\c NO) the internal documentation. <hr> \section cmdmainpage \\mainpage [(title)] diff --git a/doc/config.doc b/doc/config.doc index a4402d1..c2f988e 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -572,7 +572,7 @@ followed by the descriptions of the tags grouped by category. Doxygen has a built-in mapping, but you can override or extend it using this tag. The format is ext=language, where ext is a file extension, and language is one of the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, - Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat + Objective-C, Python, Fortran, VHDL. For instance to make doxygen treat .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index a10cddd..bc79264 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -36,13 +36,14 @@ \renewcommand{\cftsecindent}{0 em} \renewcommand{\cftsecnumwidth}{3.2 em} \renewcommand{\cftsubsecindent}{3.2 em} +\newcommand{\thisyear}{\the\year} \begin{document} \begin{titlepage} \includegraphics[width=\textwidth]{doxygen_logo} \begin{center} Manual for version $VERSION\\[2ex] Written by Dimitri van Heesch\\[2ex] -\copyright 1997-2007 +\copyright 1997-\thisyear \end{center} \end{titlepage} \clearemptydoublepage diff --git a/doc/install.doc b/doc/install.doc index b668dde..b8b8154 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -209,6 +209,7 @@ The solution: go to the root of the doxygen distribution and do: cd qt ln -s your-qt-include-dir-here include ln -s your-qt-lib-dir-here lib + ln -s your-qt-bin-dir-here bin export QTDIR=$PWD \endverbatim diff --git a/doc/language.doc b/doc/language.doc index c4c1e10..ec2fc27 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.6.3), 38 languages +Currently (version 1.7.1), 38 languages are supported (sorted alphabetically): Afrikaans, Arabic, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, @@ -278,7 +278,7 @@ when the translator was updated. <td>Turkish</td> <td>Emin Ilker Cetinbas</td> <td>niw3 at yahoo dot com</td> - <td>1.6.0</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Ukrainian</td> @@ -400,7 +400,7 @@ when the translator was updated. \hline Swedish & Mikael Hallin & {\tt\tiny mikaelhallin at yahoo dot se} & 1.6.0 \\ \hline - Turkish & Emin Ilker Cetinbas & {\tt\tiny niw3 at yahoo dot com} & 1.6.0 \\ + Turkish & Emin Ilker Cetinbas & {\tt\tiny niw3 at yahoo dot com} & up-to-date \\ \hline Ukrainian & -- searching for the maintainer -- & {\tt\tiny } & 1.4.1 \\ \hline diff --git a/doc/starting.doc b/doc/starting.doc index 8e3e0d2..d90d136 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -38,6 +38,17 @@ tries to be complete): \image html infoflow.gif "Doxygen information flow" \image latex infoflow.eps "Doxygen information flow" width=14cm +\section step0 Step 0: Check if doxygen supports your programming language + +First, assure that your programming language has a reasonable chance of being +recognized by Doxygen. These languages are supported by default: C, C++, C#, +Objective-C, IDL, Java, VHDL, PHP, Python, Fortran, and D. It +is possible to configure certain filetype extensions to use certain parsers: +see the \ref cfg_extension_mapping "Configuration/ExtensionMappings" for details. +Also, completely different languages can be supported by using preprocessor +programs: see the <a href="http://www.doxygen.org/helpers.html">Helpers page</a> +for details. + \section step1 Step 1: Creating a configuration file Doxygen uses a configuration file to determine all of its settings. @@ -163,7 +174,8 @@ require a browser that supports DHTML and Javascript. \subsection latex_out LaTeX output \addindex LaTeX The generated \f$\mbox{\LaTeX}\f$ documentation must first be compiled by -a \f$\mbox{\LaTeX}\f$ compiler (I use a recent teTeX distribution). +a \f$\mbox{\LaTeX}\f$ compiler (I use a recent teTeX distribution for Linux +and MacOSX and MikTex for Windows). To simplify the process of compiling the generated documentation, \c doxygen writes a \c Makefile into the \c latex directory. @@ -250,7 +262,7 @@ basically two options: </ol> Files can only be documented using the second option, since there is no way to put a documentation block before a file. Of course, file members -(functions, variable, typedefs, defines) do not need an explicit +(functions, variables, typedefs, defines) do not need an explicit structural command; just putting a special documentation block in front or behind them will do. diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 6d1c243..a79f1da 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.6.3) +(1.7.1) Doxygen supports the following 38 languages (sorted alphabetically): @@ -10,7 +10,7 @@ Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese. -Of them, 9 translators are up-to-date, 29 translators are based on +Of them, 10 translators are up-to-date, 28 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -28,6 +28,7 @@ still may be some details listed even for them: TranslatorPersian -- The MAX_DOT_GRAPH_HEIGHT found in trLegendDocs() TranslatorSlovak TranslatorSpanish -- The MAX_DOT_GRAPH_HEIGHT found in trLegendDocs() + TranslatorTurkish ---------------------------------------------------------------------- The following translator classes need some maintenance (the most @@ -46,7 +47,6 @@ must be implemented to become up-to-date: TranslatorEsperanto 1.6.3 4 methods to implement (1 %) TranslatorCatalan 1.6.3 4 methods to implement (1 %) TranslatorVietnamese 1.6.0 9 methods to implement (4 %) - TranslatorTurkish 1.6.0 9 methods to implement (4 %) TranslatorSwedish 1.6.0 9 methods to implement (4 %) Note: Reimplementation using UTF-8 suggested. @@ -878,24 +878,6 @@ TranslatorSwedish (TranslatorAdapter_1_6_0) 9 methods to implement (4 %) virtual QCString trIncludesFileIn(const char * name) -TranslatorTurkish (TranslatorAdapter_1_6_0) 9 methods to implement (4 %) ------------------ - - Implements 216 of the required methods (96 %). - - Missing methods (should be implemented): - - virtual QCString trSearching() - virtual QCString trNoMatches() - virtual QCString trLoading() - virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, bool includeTime) - virtual QCString trFileIn(const char * name) - virtual QCString trGlobalNamespace() - virtual QCString trDirRelation(const char * name) - virtual QCString trDirDependency(const char * name) - virtual QCString trIncludesFileIn(const char * name) - - TranslatorUkrainian (TranslatorAdapter_1_4_1) 33 methods to implement (14 %) ------------------- |