diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/config.doc b/doc/config.doc index f27f4a3..9a16a7b 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -914,7 +914,19 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" If the \c USE_HTAGS tag is set to \c YES then the references to source code will point to the HTML generated by the htags(1) tool instead of doxygen built-in source browser. The htags tool is part of GNU's global source - tagging system (see http://www.gnu.org/software/global/global.html) + tagging system (see http://www.gnu.org/software/global/global.html). + The use it do the following: + + -# Install the latest version of global (i.e. 4.8.6 or better) + -# Enable SOURCE_BROWSER and USE_HTAGS in the config file + -# Make sure the INPUT points to the root of the source tree + -# Run doxygen as normal + + Doxygen will invoke htags (and that will in turn invoke gtags), so these tools + must be available from the command line (i.e. in the search path). + + The result: instead of the source browser generated by doxygen, the links to + source code will now point to the output of htags. </dl> |