New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GENERATE_TAGFILE no longer includes any @*section links (Origin: bugzilla #734727) #5544

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity blocker in component general for ---
Reported in version 1.8.7 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2014-08-13 15:57:19 +0000, David Nichols wrote:

Created attachment 283309
incorrect file built with doxygen 1.8.7

For example - with doxygen 1.8.6 (expected output) - I get the following in my tag file:

index <title>Mapper Module</title> index mapperintro mapperexamples mapperkeys mapperoptions mapperrelnotes mapperv1_0

with the same file processed by doxygen 1.8.7, I get the following (no docanchor tags):

index <title>Mapper Module</title> index

Excuse me if I label this bug a blocker if no one else is worried, but it's a blocker for me - I have a huge documentation set which is pretty much broken with doxygen 1.8.7. I've had to downgrade to doxygen 1.8.6 where this works properly.

I found this link:
http://doxygen.10944.n7.nabble.com/TAGFILES-not-working-consistently-in-1-8-7-RHEL6-td6688.html

which appears to be the same problem, so it affects other users as well, I believe.

On 2014-08-13 15:58:10 +0000, David Nichols wrote:

Created attachment 283310
correct file created by doxygen 1.8.6

On 2014-08-14 10:22:51 +0000, Dimitri van Heesch wrote:

So far I haven't been able to reproduce this behaviour, so can you please include a self-contained example (source+config file) that produces a wrong tag file for 1.8.7 but not for 1.8.6?

On 2014-08-14 14:14:34 +0000, David Nichols wrote:

Created attachment 283387
source code to reproduce the tag bug with doxygen 1.8.7

note that this configuration generates a tagfile with one tag with doxygen 1.8.6 but not with doxygen 1.8.7

I could only get the bug to reproduce with the large TAGFILES entry (the same one I use when building the docs that triggered the bug) - included in the tar file (qore.tag)

Please contact me if you need more info - I hope you can reproduce the bug with this input (I could do it repeatedly)

On 2014-08-14 17:35:18 +0000, Dimitri van Heesch wrote:

The problem was that the tag file also defines a mainpage. Doxygen nowadays checks (and warns) about double entries and ignores rather than merges duplicates to avoid broken links.

I've now changed it by ignoring the mainpage reference in the tag file, see commit here:
SHA: 7d9d432

On 2014-08-14 19:38:07 +0000, David Nichols wrote:

I built doxygen from git sources and now the tag files are being created with the docanchor elements as expected and as with doxygen 1.8.6, so that looks great.

Unfortunately some of the links to external docs aren't working in the generated HTML, but maybe that's due to another in-progress issue with the git sources?

If it helps (in case it's not a known issue), in this example I have the following in my doxyfile:

TAGFILES = qore.tag=../../../lang/html Mime.tag=../../Mime/html MailMessage.tag=../../MailMessage/html Util.tag=../../Util/html HttpServer.tag=../../HttpServer/html WebSocketUtil.tag=../../WebSocketUtil/html SqlUtil.tag=../../SqlUtil/html Mapper.tag=../../Mapper/html

the links from the last two tagfiles are not working; the links from the first tagfile is working, and the rest in the middle are probably not used (they are there by default since the doxyfiles are build dynamically).

If I run doxygen 1.8.6 on the same Doxyfile and tagfiles, everything works (which means that the tagfiles created by 1.8.7-git are fine).

On 2014-08-15 08:03:05 +0000, Dimitri van Heesch wrote:

Hmm, that's new to me.

Is it a particular link that doesn't work, or any link?

Does doxygen produce warning messages, for instance about multiple use of section labels or when processing the tag files?

Is it possible to create a self-contained example for this?

On 2014-08-15 10:30:31 +0000, David Nichols wrote:

Created attachment 283445
source to reproduce the non-working link from tagfile bug

links from the tagfile created after the last git fix do not work - I've included a self-contained example.

Running doxygen 1.8.6 gives no errors, and documentation with working links, whereas doxygen 1.8.7-git outputs an error and no links (/Users/david/src/qore/tmp/dox-187-bug/Test.h:5: warning: unable to resolve reference to `mapperoptions' for \ref command)

On 2014-08-18 08:27:52 +0000, Dimitri van Heesch wrote:

I've improved my previous fix by allowing references to sections defined in a mainpage even when imported via a tagfile, while still ignoring the mainpage itself.

See:
SHA: 8b279c9

Let me know if this works for you.

On 2014-08-18 08:39:00 +0000, David Nichols wrote:

Thanks - just tested a build from the latest git sources after your commit, and it works perfectly.

From my point of view, this bug is resolved.

thanks a lot for the fix and (it goes without saying) for the excellent documentation system

David

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment