diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.doc | 56 | ||||
| -rw-r--r-- | doc/install.doc | 38 | ||||
| -rw-r--r-- | doc/language.doc | 11 | ||||
| -rw-r--r-- | doc/translator_report.txt | 20 |
4 files changed, 73 insertions, 52 deletions
diff --git a/doc/config.doc b/doc/config.doc index 8885525..ab2934d 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -19,7 +19,7 @@ \section config_format Format A configuration file is a free-form ASCII text file with a structure -that is similar to that of a Makefile, default name \c Doxyfile. It is +that is similar to that of a Makefile, with the default name \c Doxyfile. It is parsed by \c doxygen. The file may contain tabs and newlines for formatting purposes. The statements in the file are case-sensitive. Comments may be placed anywhere within the file (except within quotes). @@ -35,7 +35,7 @@ new values to the list. Values are sequences of non-blanks. If the value should contain one or more blanks it must be surrounded by quotes ("..."). Multiple lines can be concatenated by inserting a backslash (\\) as the last character of a line. Environment variables can be expanded -using the pattern \c \$(ENV_VARIABLE_NAME). +using the pattern <code>\$(ENV_VARIABLE_NAME)</code>. You can also include part of a configuration file from another configuration file using a <code>\@INCLUDE</code> tag as follows: @@ -77,7 +77,9 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_disable_index DISABLE_INDEX \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC \refitem cfg_dot_image_format DOT_IMAGE_FORMAT +\refitem cfg_dot_multi_targets DOT_MULTI_TARGETS \refitem cfg_dot_path DOT_PATH +\refitem cfg_dot_transparent DOT_TRANSPARENT \refitem cfg_dotfile_dirs DOTFILE_DIRS \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE @@ -98,6 +100,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_extract_private EXTRACT_PRIVATE \refitem cfg_extract_static EXTRACT_STATIC \refitem cfg_file_patterns FILE_PATTERNS +\refitem cfg_file_version_filter FILE_VERSION_FILTER \refitem cfg_filter_patterns FILTER_PATTERNS \refitem cfg_filter_source_files FILTER_SOURCE_FILES \refitem cfg_full_path_names FULL_PATH_NAMES @@ -726,6 +729,39 @@ documentation. *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm </code> +\anchor cfg_file_version_filter +<dt>\c FILE_VERSION_FILTER <dd> + \addindex FILE_VERSION_FILTER + The \c FILE_VERSION_FILTER tag can be used to specify a program or script that + doxygen should invoke to get the current version for each file (typically from the + version control system). Doxygen will invoke the program by executing (via + popen()) the command <code>command input-file</code>, where \c command is + the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name + of an input file provided by doxygen. + Whatever the progam writes to standard output is used as the file version. + +Example of using a shell script as a filter for Unix: +\verbatim + FILE_VERSION_FILTER = "/bin/sh versionfilter.sh" +\endverbatim + +Example shell script for CVS: +\verbatim +#!/bin/sh +cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p' +\endverbatim + +Example shell script for Subversion: +\verbatim +#!/bin/sh +svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p' +\endverbatim + +Example filter for ClearCase: +\verbatim +FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" +\endverbatim + \anchor cfg_recursive <dt>\c RECURSIVE <dd> \addindex RECURSIVE @@ -1655,6 +1691,22 @@ not depth-constraint. the specified constraint. Beware that most browsers cannot cope with very large images. +\anchor cfg_dot_transparent +<dt>\c DOT_TRANSPARENT <dd> + \addindex DOT_TRANSPARENT + Set the \c DOT_TRANSPARENT tag to \c YES to generate images with a transparent + background. This is disabled by default, which results in a white background. + Warning: Depending on the platform used, enabling this option may lead to badly + anti-aliased labels on the edges of a graph (i.e. they become hard to read). + +\anchor cfg_dot_multi_targets +<dt>\c DOT_MULTI_TARGETS <dd> + \addindex DOT_MULTI_TARGET + Set the \c DOT_MULTI_TARGETS tag to \c YES allow dot to generate multiple output + files in one run (i.e. multiple -o and -T options on the command line). This + makes dot run faster, but since only newer versions of dot (>1.8.10) + support this, this feature is disabled by default. + \anchor cfg_generate_legend <dt>\c GENERATE_LEGEND <dd> \addindex GENERATE_LEGEND diff --git a/doc/install.doc b/doc/install.doc index 3c9a74b..950fe02 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -104,9 +104,9 @@ Compilation is now done by performing the following steps: See the <code>PLATFORMS</code> file for a list of possible platform options. - If you have Qt-2.1.x installed and want to build the GUI front-end, you - should run the configure script with the <code>--with-doxywizard</code> - option: + If you have Qt-3.2.x or higher installed and want to build the GUI + front-end, you should run the configure script with + the <code>--with-doxywizard</code> option: \verbatim configure --with-doxywizard @@ -297,32 +297,10 @@ ce_parse.cpp: <b>Sun compiler problems</b> -I tried compiling doxygen only with Sun's C++ WorkShop Compiler -version 5.0 (I used <code>./configure --platform solaris-cc</code>) - -Qt-2.x.y is required for this compiler (Qt-1.44 has problems with the bool -type). - -Compiling the \c doxygen binary went ok, but while linking <code>doxytag</code> I got a -lot of link errors, like these: - -\verbatim -QList<PageInfo>::__vtbl /home/dimitri/doxygen/ -objects/SunWS_cache/CC_obj_6/6c3eO4IogMT2vrlGCQUQ.o -[Hint: try checking whether the first non-inlined, non-pure -virtual function of class QList<PageInfo> is defined] -\endverbatim - -These are generated because the compiler is confused about the object sharing -between \c doxygen and \c doxytag. To compile \c doxytag -anyway do: - -\verbatim -rm -rf objects -mkdir objects -cd src -gmake -f Makefile.doxytag -\endverbatim +It appears that doxygen doesn't work properly if it is compiled +with Sun's C++ WorkShop Compiler. I cannot verify this myself as I do +not have access to a Solaris machine with this compiler. With GNU compiler +it does work. when configuring with <code>--static</code> I got: @@ -467,7 +445,7 @@ Here is what is required: still a requirement however. A commercial license to build doxywizard with the latest Qt library was kindly donated to me by the nice people at <a href="http://www.trolltech.com">TrollTech</a>. - See doxygen download page for a link. + See doxygen download page for a link. <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 38e629d..3737086 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.3.9.1-20041129), 30 languages +Currently (version 1.3.9.1-20041221), 30 languages are supported (sorted alphabetically): Afrikaans, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, @@ -160,9 +160,9 @@ when the translator was updated. </tr> <tr bgcolor="#ffffff"> <td>Korean</td> - <td>Richard Kim</td> - <td>ryk at dspwiz dot com</td> - <td>1.3.8</td> + <td>SooYoung Jung<br>Richard Kim</td> + <td>jung5000 at gmail dot com<br>ryk at dspwiz dot com</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>KoreanEn</td> @@ -299,7 +299,8 @@ when the translator was updated. \hline JapaneseEn & see the Japanese language & {\tt\tiny ~} & English based \\ \hline - Korean & Richard Kim & {\tt\tiny ryk@dspwiz.com} & 1.3.8 \\ + Korean & SooYoung Jung & {\tt\tiny jung5000@gmail.com} & up-to-date \\ + ~ & Richard Kim & {\tt\tiny ryk@dspwiz.com} & ~ \\ \hline KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\ \hline diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 41cb44f..9a80657 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.3.9.1-20041129) +(1.3.9.1-20041221) Doxygen supports the following 30 languages (sorted alphabetically): @@ -8,7 +8,7 @@ German, Greek, Hungarian, Italian, Japanese (+En), Korean (+En), Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. -Of them, 14 translators are up-to-date, 16 translators are based on +Of them, 15 translators are up-to-date, 15 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -27,6 +27,7 @@ still may be some details listed even for them: TranslatorGerman TranslatorHungarian TranslatorItalian + TranslatorKorean -- Change the base class to Translator. TranslatorPolish TranslatorRussian TranslatorSerbian @@ -44,7 +45,6 @@ must be implemented to become up-to-date: TranslatorAfrikaans 1.3.9 6 methods to implement TranslatorSpanish 1.3.8 7 methods to implement TranslatorLithuanian 1.3.8 7 methods to implement - TranslatorKorean 1.3.8 7 methods to implement TranslatorChinesetraditional 1.3.8 7 methods to implement TranslatorPortuguese 1.3.3 11 methods to implement TranslatorSlovak 1.2.18 20 methods to implement @@ -340,20 +340,10 @@ TranslatorJapaneseEn (TranslatorEnglish) 196 methods to implement virtual QCString idLanguageCharset() -TranslatorKorean (TranslatorAdapter_1_3_8) 7 methods to implement +TranslatorKorean (TranslatorAdapter_1_3_9) ---------------- - Implements 194 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trDirIndex() - virtual QCString trDirDocumentation() - virtual QCString trDirectories() - virtual QCString trDirDescription() - virtual QCString trSourceFile(QCString & filename) - virtual QCString trDirReference(const char * dirName) - virtual QCString trDir(bool first_capital, bool singular) + Implements 201 of the required methods. TranslatorKoreanEn (TranslatorEnglish) 196 methods to implement |