Re: [Toon-members] [PATCH] Generate doxygen tag file

[Pekka Paalanen]

On Wed, 16 Jun 2010 14:18:02 +0100 (BST)
"E. Rosten" <address@hidden> wrote:

> On Tue, 15 Jun 2010, Pekka Paalanen wrote:
> 
> > Generating the doxygen tag file allows external projects to link
> > their doxygen documentation to the TooN documentation.
> 
> What does this patch do? I don't quite follow...

When Doxygen generates TooN docs, this patch makes it generate also a
tag file. Then, when I separately generate Doxygen docs for my own
project, and point TAGFILES to the TooN tag file, I get links to the
TooN docs in my own documentation.

For instance, assume my project has a function with a parameter
of type TooN::SE3. When I go to the documentation of that function, the
type "TooN::SE3" will be a link to the TooN documentation. Without tag
files it is just an undocumented type.

Did I manage to explain it?

The relevant Doxygen manual page is
http://www.stack.nl/~dimitri/doxygen/external.html

How should I modify the commit message to be more clear?

> Presumably it would be worth having the TAGFILES line in the doxyfile
> as well, since that matches the kind of directory structure TooN is
> installed to (by default it goes in /usr/local/include/TooN, which
> matches include/TooN)

No, TAGFILES is for "the other" Doxyfile, the foreign Doxyfile in
TooN's perspective. TooN just needs to generate the tag file, so
another project can reference it as external documentation.

TooN could even be installed system wide, with docs and the tag file.
Then my project could reference the system version of TooN
documentation.

The point is that TooN documentation is separate from the project that
uses it. I rarely need to regenerate TooN docs, contrary to my project
docs. Also, the doxygen configuration for TooN and my project can be
different.

> > Assume a directory structure:
> > ./Doxyfile
> > ./src/           - my project sources
> > ./doc/html/      - my doxygen generated docs
> > ./include/TooN/  - checkout of Toon
> >
> > Adding
> > TAGFILES = include/TooN/TooN-doxy.tag=../../include/TooN/html
> > to my project's Doxyfile allows doxygen to automatically reference
> > the TooN documentation.
> >
> > Signed-off-by: Pekka Paalanen <address@hidden>
> > ---
> > Doxyfile |    2 +-
> > 1 files changed, 1 insertions(+), 1 deletions(-)
> >
> > diff --git a/Doxyfile b/Doxyfile
> > index b470115..1c4b261 100644
> > --- a/Doxyfile
> > +++ b/Doxyfile
> > @@ -956,7 +956,7 @@ TAGFILES               =
> > # When a file name is specified after GENERATE_TAGFILE, doxygen
> > will create # a tag file that is based on the input files it reads.
> >
> > -GENERATE_TAGFILE       =
> > +GENERATE_TAGFILE       = TooN-doxy.tag
> >
> > # If the ALLEXTERNALS tag is set to YES all external classes will
> > be listed # in the class index. If set to NO only the inherited
> > external classes -- 
> > 1.6.4.4

-- 
Pekka Paalanen, M.Sc. (Eng.)   LUT/IT, room 6505
doctoral student               http://www.it.lut.fi/project/rtmosaic/
address@hidden          http://www.iki.fi/pq/