Re: [Doxygen-users] External Documentation

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Josh Quigley wrote:
> All the doxygen output is perfect if a build proj1 + library, proj2 + 
> library etc but this is slow and means I have multiple copies of the 
> library code. The closest I have got is producing a tagfile for the 
> library (contents look OK, but I’m no expert). The library html output 
> is perfect. Then for proj1, say, I set the TAGFILES parameter to 
> <tagfile>=<html directory>. 

TAGFILES should work. You should be able to tell which links go to the other 
documentation because they will have a different style.

Here's an example of using tag files:

Directory structure looks like this:

Library/:
   Library/doc
   Library/doxygen.conf
   Library/src
   Library/SubLib:
     Library/SubLib/doc
     Library/SubLib/doxygen.conf
     Library/SubLib/src

Library/SubLib/doxygen.conf contains:
   TAGFILES = ../../doc/Library.tag=../../doc
These paths are relative to Library/SubLib/doc.

To create Library.tag, Library/doxygen.conf has this:
   GENERATE_TAGFILE = doc/Library.tag
This path is relative to the Library directory, since that's the directory from 
which doxygen is actually run, with doxygen.conf as its configuration.

SubLib can also create a tag file:
   GENERATE_TAGFILE = doc/SubLib.tag
This is relative to Library/SubLib, which is the current directory when doxygen 
is run for the second time. (e.g. make -C SubLib docs)

The tag file generated by doxygen is an XML file with the root element <tagfile> 
It should contain elements named <compound> containing <member> elements (and 
maybe other <compounds> with other stuff depending on what kinds of things you 
have documented).

Reed