Thread: Re: [Doxygen-users] Including other docs via TAGFILES does not work as expected

Brought to you by: dimitri

doxygen-users

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

From: <dr...@ca...> - 2001-12-11 19:05:30

Attachments: =?iso-8859-1?Q?test.zip?=

Did you try running installdox from the html directory? This will modif=
y
the links in the html to the other documentation's directory.
Just type lib/html/installdox for command format.

For your program, it will be something like this : lib/html/installdox =
-l
lib.tag@../../html

Installdox is very useful when your website has a different dir structu=
re
than your generated .html ...



Thomas Ziegler <zi...@co...>@lists.sourceforge.net on
12/11/2001 01:20:55 PM

Sent by:  dox...@li...


To:   dox...@li...
cc:
Subject:  [Doxygen-users] Including other docs via TAGFILES does not wo=
rk
      as expected


Hi all,

I'm not able to include doxygen-docu of a library into another project =
if
the source files reside in another (sub)-directory.

I've attached a small example which looks like this:

- ./test.dox
  ./src/
    - file1.c
    - file1.h
    - file2.c
    - file2.h
  ./lib/lib.dox
  ./lib/src/
        - file1.c
        - file1.h
           - file3.c
           - file3.h


File 'file1.c' contains a call to a library function 'lib2()' in
'lib/src/file3.c'

The command

  cd lib; doxygen lib.dox

creates lib/html/... and the tagfile lib/lib.tag. lib/lib.tag is refere=
nced
by test.dox. The command

  doxygen test.dox

creates ./html/...

Browsing through the sources of ./html/file1_8c-source.html shows an ac=
tive
link for lib2(). Unfortunately it points to an invalid location
./html/file3_8c.html#a0.

I.e. the link points to the current html-subdir instead of the one in
lib/html.

Any hints?

Thanks in advance,
Thomas

PS: same behavior for 1.2.5 and 1.2.12



--
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=FCrnberg, Germany
mailto:zi...@Co...  | http://www.CodingTechnologies.com
(See attached file: test.zip)
=

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

From: <dr...@ca...> - 2001-12-12 14:27:24

In the example, I wrongly assumed you were generating the tag file the
other way around.
Yet again I said it would look "something" like it. lol

Now, assuming that lib.tag is generated with ./lib/html/ documentation =
and
./html 's documentation references to it, then
the correct command should be :   installdox -l lib.tag@../lib/html  an=
d
runned from directory ./html/

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

html link Before:
     <a class=3D"codeRef" doxygen=3D"lib.tag:" href=3D"myReferencedFile=
.html">
MyReferencedFunction</a>
html link After:
     <a class=3D"codeRef" doxygen=3D"lib.tag:../lib/html" href=3D"../li=
b/html/
myReferencedFile.html"> MyReferencedFunction</a>




Thomas Ziegler <zi...@co...>@lists.sourceforge.net on
12/12/2001 07:47:12 AM

Sent by:  dox...@li...


To:   Denis Ricard/Toronto/IBM@IBMCA
cc:   dox...@li...
Subject:  Re: [Doxygen-users] Including other docs via TAGFILES does no=
t
      work as expected




On Tue, Dec 11, 2001 at 02:05:07PM -0500, dr...@ca... wrote:
>
> Did you try running installdox from the html directory? This will mod=
ify
> the links in the html to the other documentation's directory.
> Just type lib/html/installdox for command format.

I thought, that this message:

Now copy the file

     /home/zie/tmp/doxygent.tst/test/html/search.cgi

     to the directory where the CGI binaries are located and don't forg=
et
to
run

     /home/zie/tmp/doxygent.tst/test/html/installdox

to replace any dummy links.

was only meant for the search stuff (there is no search.cgi)

>
> For your program, it will be something like this : lib/html/installdo=
x -l
> lib.tag@../../html

It seems, that I do not understand clearly the syntax of installdox

 - ./html     contains the main module
              lib.tag is included here
                 html/installdox exists

 - ./lib/html contains the additional library
              lib.tag is generated here
                 no html/installdox exists

I tried from ./:

  html/installdox -l lib.tag@lib html/

which does not work.




>
> Installdox is very useful when your website has a different dir struc=
ture
> than your generated .html ...
>
>
>
> Thomas Ziegler <zi...@co...>@lists.sourceforge.net on
> 12/11/2001 01:20:55 PM
>
> Sent by:  dox...@li...
>
>
> To:   dox...@li...
> cc:
> Subject:  [Doxygen-users] Including other docs via TAGFILES does not =
work
>       as expected
>
>
> Hi all,
>
> I'm not able to include doxygen-docu of a library into another projec=
t if
> the source files reside in another (sub)-directory.
>
> I've attached a small example which looks like this:
>
> - ./test.dox
>   ./src/
>     - file1.c
>     - file1.h
>     - file2.c
>     - file2.h
>   ./lib/lib.dox
>   ./lib/src/
>         - file1.c
>         - file1.h
>            - file3.c
>            - file3.h
>
>
> File 'file1.c' contains a call to a library function 'lib2()' in
> 'lib/src/file3.c'
>
> The command
>
>   cd lib; doxygen lib.dox
>
> creates lib/html/... and the tagfile lib/lib.tag. lib/lib.tag is
referenced
> by test.dox. The command
>
>   doxygen test.dox
>
> creates ./html/...
>
> Browsing through the sources of ./html/file1_8c-source.html shows an
active
> link for lib2(). Unfortunately it points to an invalid location
> ./html/file3_8c.html#a0.
>
> I.e. the link points to the current html-subdir instead of the one in=

> lib/html.
>
> Any hints?
>
> Thanks in advance,
> Thomas
>
> PS: same behavior for 1.2.5 and 1.2.12
>
>
>
> --
> 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=FCrnberg, Germany
> mailto:zi...@Co...  | http://www.CodingTechnologies.co=
m
> (See attached file: test.zip)



--
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=FCrnberg, Germany
mailto:zi...@Co...  | http://www.CodingTechnologies.com

_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

=

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

From: Thomas Z. <zi...@co...> - 2001-12-12 12:50:32

On Tue, Dec 11, 2001 at 02:05:07PM -0500, dr...@ca... wrote:
> 
> Did you try running installdox from the html directory? This will modify
> the links in the html to the other documentation's directory.
> Just type lib/html/installdox for command format.

I thought, that this message:

Now copy the file

     /home/zie/tmp/doxygent.tst/test/html/search.cgi
     
     to the directory where the CGI binaries are located and don't forget to
run

     /home/zie/tmp/doxygent.tst/test/html/installdox
     
to replace any dummy links.

was only meant for the search stuff (there is no search.cgi)

> 
> For your program, it will be something like this : lib/html/installdox -l
> lib.tag@../../html

It seems, that I do not understand clearly the syntax of installdox

 - ./html     contains the main module
              lib.tag is included here
	      html/installdox exists
 
 - ./lib/html contains the additional library
              lib.tag is generated here 
	      no html/installdox exists
	      
I tried from ./:

  html/installdox -l lib.tag@lib html/
  
which does not work.




> 
> Installdox is very useful when your website has a different dir structure
> than your generated .html ...
> 
> 
> 
> Thomas Ziegler <zi...@co...>@lists.sourceforge.net on
> 12/11/2001 01:20:55 PM
> 
> Sent by:  dox...@li...
> 
> 
> To:   dox...@li...
> cc:
> Subject:  [Doxygen-users] Including other docs via TAGFILES does not work
>       as expected
> 
> 
> Hi all,
> 
> I'm not able to include doxygen-docu of a library into another project if
> the source files reside in another (sub)-directory.
> 
> I've attached a small example which looks like this:
> 
> - ./test.dox
>   ./src/
>     - file1.c
>     - file1.h
>     - file2.c
>     - file2.h
>   ./lib/lib.dox
>   ./lib/src/
>         - file1.c
>         - file1.h
>            - file3.c
>            - file3.h
> 
> 
> File 'file1.c' contains a call to a library function 'lib2()' in
> 'lib/src/file3.c'
> 
> The command
> 
>   cd lib; doxygen lib.dox
> 
> creates lib/html/... and the tagfile lib/lib.tag. lib/lib.tag is referenced
> by test.dox. The command
> 
>   doxygen test.dox
> 
> creates ./html/...
> 
> Browsing through the sources of ./html/file1_8c-source.html shows an active
> link for lib2(). Unfortunately it points to an invalid location
> ./html/file3_8c.html#a0.
> 
> I.e. the link points to the current html-subdir instead of the one in
> lib/html.
> 
> Any hints?
> 
> Thanks in advance,
> Thomas
> 
> PS: same behavior for 1.2.5 and 1.2.12
> 
> 
> 
> --
> 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
> (See attached file: test.zip)



-- 
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