summaryrefslogtreecommitdiffstats
path: root/doc/external.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/external.doc')
-rw-r--r--doc/external.doc36
1 files changed, 9 insertions, 27 deletions
diff --git a/doc/external.doc b/doc/external.doc
index a1be8b1..2a6426e 100644
--- a/doc/external.doc
+++ b/doc/external.doc
@@ -58,21 +58,15 @@ To combine the output of one or more external projects with your own project
you should specify the name of the tag files after
the \ref cfg_tagfiles "TAGFILES" option in the configuration file.
-A tag file does not contain information about where the external documentation
-is located. This could be a directory or an URL. So when you include a tag
-file you have to specify where the external documentation is located.
-There are two ways to do this:
-<dl>
-<dt>At configuration time:<dd> just assign the location of the output to the
- tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration
- option. If you use a relative path it should be relative with respect to
- the directory where the HTML output of your project is generated.
-<dt>After compile time:<dd> if you do not assign a location to a tag file,
- doxygen will generate dummy links for all external HTML references. It will
- also generate a perl script called \ref installdox_usage "installdox" in
- the HTML output directory. This script should be run to replace the
- dummy links with real links for all generated HTML files.
-</dl>
+A tag file typically only contains a relative location of the documentation from the
+point where doxygen was run. So when you include a tag file in other project
+you have to specify where the external documentation is located in relation this project.
+You can do this in the configuration file by assigning the (relative) location to the
+tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration
+option. If you use a relative path it should be relative with respect to
+the directory where the HTML output of your project is generated; so a relative path
+from the HTML output directory of a project to the HTML output of the other project that
+is linked to.
\par Example:
Suppose you have a project \c proj that uses two external
@@ -118,18 +112,6 @@ OUTPUT_DIRECTORY = ext2
GENERATE_TAGFILE = ext2/ext2.tag
\endverbatim
-In some (hopefully exceptional) cases you may have the documentation
-generated by doxygen, but not the sources nor a tag file. In this case you
-can use the \ref doxytag_usage "doxytag" tool to extract a tag file from
-the generated HTML sources. Another case where you should use doxytag is
-if you want to create a tag file for the Qt documentation.
-
-The tool \c doxytag depends on the particular structure
-of the generated output and on some special markers that are generated by
-doxygen. Since this type of extraction is brittle and error-prone I
-suggest you only use this approach if there is no alternative. The
-doxytag tool may even become obsolete in the future.
-
\htmlonly
Go to the <a href="faq.html">next</a> section or return to the
<a href="index.html">index</a>.