doxygen-users

RE: [Doxygen-users] Including other docs via TAGFILES does not work asexpected

[Morgenthaler, G. <g.m...@vi...>]

> Anyhow, installdox will simply append what you submit after=20
> the @ sign to the links from the tag file before the @ sign.

Maybe I'm wrong but I think both of you don't need installdox as
installdox is only necessary if you want to change a path in an
already _created_ documentation after you moved it to another
location.

I "configure" my tagfile links at documentation creation time
with something like this:

TAGFILES =3D ../../boblib/doc/boblib.tag=3D../../../boblib/doc/html \
           ../../flclib/doc/flclib.tag=3D../../../flclib/doc/html

in my doxygen.cfg and don't use installdox at all.

Regards, Germar

RE: [Doxygen-users] Including other docs via TAGFILES does not work asexpected

[Morgenthaler, G. <g.m...@vi...>]

> Your statement is only partly true. Installdox isn't just for moving a
> system or search.
> If you are creating a system out of multiple Doxygen runs and one
system
> depends/inherits from another, you would:
1) Have the parent system generate a tag file.
2) Have the child system reference the tag file.
3) Later, after the system is built, use installdox to resolve inherited
references.

And I thought I'm doing exactly this without needing step 3) ;-)

I have a library at:

~/src/boblib/*.cpp *.hpp
~/src/boblib/doc/doxygen.cfg

I have a library at:

~/src/flclib/*.cpp *.hpp
~/src/flclib/doc/doxygen.cfg

And a program that uses that libraries at:

~/src/flcman/*.cpp *.hpp
~/src/flcman/doc/doxygen.cfg

What I do is:

1) I create the documentation and tagfile for boblib in
~/src/boblib/doc/boblib.tag
~/src/boblib/doc/html/
thru running doxygen doxygen.cfg in
~/src/boblib/doc

2) I create the documentation and tagfile for flclib in
~/src/flclib/doc/boblib.tag
~/src/flclib/doc/html/
thru running doxygen doxygen.cfg in
~/src/flclib/doc

3) I create the documentation for flcman in
~src/flcman/doc/html/
with:
TAGFILES =3D ../../boblib/doc/boblib.tag=3D../../../boblib/doc/html \
           ../../flclib/doc/flclib.tag=3D../../../flclib/doc/html
thru running doxygen doxygen.cfg in
~/src/flcman/doc

The links in flcman documentation are resolved to boblib and flclib.

Still no installdox involved.

Regards, Germar

Re: [Doxygen-users] Including other docs via TAGFILES does not work asexpected

[Thomas Z. <zi...@co...>]

A related question:

How do I reference the \mainpage or other \sections of the client systems,
e.g. boblib and flclib from the parent system flcman?

Thanks in advance,
Thomas

On Wed, Dec 12, 2001 at 04:45:36PM +0100, Morgenthaler, Germar wrote:
> 
> > Your statement is only partly true. Installdox isn't just for moving a
> > system or search.
> > If you are creating a system out of multiple Doxygen runs and one
> system
> > depends/inherits from another, you would:
> 1) Have the parent system generate a tag file.
> 2) Have the child system reference the tag file.
> 3) Later, after the system is built, use installdox to resolve inherited
> references.
> 
> And I thought I'm doing exactly this without needing step 3) ;-)
> 
> I have a library at:
> 
> ~/src/boblib/*.cpp *.hpp
> ~/src/boblib/doc/doxygen.cfg
> 
> I have a library at:
> 
> ~/src/flclib/*.cpp *.hpp
> ~/src/flclib/doc/doxygen.cfg
> 
> And a program that uses that libraries at:
> 
> ~/src/flcman/*.cpp *.hpp
> ~/src/flcman/doc/doxygen.cfg
> 
> What I do is:
> 
> 1) I create the documentation and tagfile for boblib in
> ~/src/boblib/doc/boblib.tag
> ~/src/boblib/doc/html/
> thru running doxygen doxygen.cfg in
> ~/src/boblib/doc
> 
> 2) I create the documentation and tagfile for flclib in
> ~/src/flclib/doc/boblib.tag
> ~/src/flclib/doc/html/
> thru running doxygen doxygen.cfg in
> ~/src/flclib/doc
> 
> 3) I create the documentation for flcman in
> ~src/flcman/doc/html/
> with:
> TAGFILES = ../../boblib/doc/boblib.tag=../../../boblib/doc/html \
>            ../../flclib/doc/flclib.tag=../../../flclib/doc/html
> thru running doxygen doxygen.cfg in
> ~/src/flcman/doc
> 
> The links in flcman documentation are resolved to boblib and flclib.
> 
> Still no installdox involved.
> 
> Regards, Germar
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

-- 
Dr.-Ing. Thomas Ziegler            |
Senior Research Engineer           | Coding Technologies
phone: +49 (0) 911 92891 -27       | Deutschherrnstr. 15-19
fax:   +49 (0) 911 92891 -99       | D-90429 Nürnberg, Germany
mailto:zi...@Co...  | http://www.CodingTechnologies.com

Re: [Doxygen-users] Including other docs via TAGFILES does not work asexpected

[Dimitri v. H. <di...@st...>]

On Wed, Dec 12, 2001 at 04:45:36PM +0100, Morgenthaler, Germar wrote:
> 
> > Your statement is only partly true. Installdox isn't just for moving a
> > system or search.
> > If you are creating a system out of multiple Doxygen runs and one
> system
> > depends/inherits from another, you would:
> 1) Have the parent system generate a tag file.
> 2) Have the child system reference the tag file.
> 3) Later, after the system is built, use installdox to resolve inherited
> references.
> 
> And I thought I'm doing exactly this without needing step 3) ;-)
> 
[snip]
> 
> The links in flcman documentation are resolved to boblib and flclib.
> 
> Still no installdox involved.

Germar is right. One should not have to deal with installdox, unless there are
plans to move the docs without regeneration. If you have two projects 
referencing each other, more than one run of doxygen is needed to bootstrap
though.

Regards,
  Dimitri

RE: [Doxygen-users] Including other docs via TAGFILES does not work asexpected

[Morgenthaler, G. <g.m...@vi...>]

> How do I reference the \mainpage or other \sections of the=20
> client systems, e.g. boblib and flclib from the parent system
> flcman?

Now _that_ is a good question.

I think you can't (in a nice way)? Or should I say you wouldn't
want to? ;-)

My normal use is to wrap the different "documentation systems"
with a handmade HTML page, linking to the main pages with a
direct link to index.html. That should work quite nice as I think
the name of the index.html file should be pretty stable.

Linking to \sections is really a problem. Coding the created
doxygen file names into my code is NOT something that attracts
me. So I just don't do it.

Now for the "you wouldn't want to": normally you follow the
link from the program to the library (you wanted to look up
something, right?) and when you are there you have the page
menu at the top where you can select the \sections of the
library documentation. It's just a few click away...

Anyway, if anybody has a nice solution I would be interested
in an answer too.

Regards, Germar