Unable to resolve reference to 'some/path/README.md' for \ref command

[godexsoft]

Describe the bug
Upgrading to 1.11.0 broke generation for some refs. Specifically in our mainpage it broke a link to a README.md.
I'm getting the warning in the title now.

The project is opensource so here are some links:

• mainpage doc generated with previous doxygen version: https://xrplf.github.io/clio/ (at the bottom, rpc/README.md link)
• mainpage src: https://github.com/XRPLF/clio/blob/develop/src/main/Mainpage.hpp

Note that we are using the [text](link) syntax but the error happens for any sort of @ref usage.

Expected behavior
It should work the same way it worked on previous version.

Version
1.11.0

[albert-github]

Upgrading to 1.11.0

From which version?

The given link might not be persistent and also the Doxyfile is of interest so:

• Can you please attach a, small, self contained example (source+configuration file in a, compressed, tar or zip file!) that allows us to reproduce the problem? Please don't add external links as they might not be persistent (also references to GitHub repositories are considered non persistent).

[godexsoft]

Upgrading to 1.11.0

From which version?

From the previous release 1.10.0.

The given link might not be persistent and also the Doxyfile is of interest so:

• Can you please attach a, small, self contained example (source+configuration file in a, compressed, tar or zip file!) that allows us to reproduce the problem? Please don't add external links as they might not be persistent (also references to GitHub repositories are considered non persistent).

The links i posted are not going anywhere. I don't have time to create small self-contained projects, sorry.
The Doxyfile (at the time of writing this) is here: https://github.com/XRPLF/clio/blob/067dd72aed90c2649717b1d27e52352af1000b71/docs/Doxyfile (permalink)

[albert-github]

The links i posted are not going anywhere.

probably they will when the account is removed (unlikely but ...)

In the linked Doxyfile I see constructs like ${LINT} would be nice to know what the used values are and not be dependent on the build procedure of project.

[godexsoft]

The links i posted are not going anywhere.

probably they will when the account is removed (unlikely but ...)

In the linked Doxyfile I see constructs like ${LINT} would be nice to know what the used values are and not be dependent on the build procedure of project.

I give up. Here is your small self-contained project. Just run ./check-docs.sh to see it fail
doxybug.tar.gz

[albert-github]

Thanks for the example.
With the doxygen 1.10.0 and 1.11.0 I get the warning:

.../src/main/Mainpage.hpp:40: warning: unable to resolve reference to 'rpc/README.md' for \ref command
.../src/main/Mainpage.hpp:40: warning: unable to resolve reference to 'rpc/README.md' for \ref command

I see between the repository / original Mainpage.hpp and the one in the example a small difference:
The example:

* Read [README.md](rpc/README.md) carefully to know more about writing your own handlers for Clio.

The file in the repository

* Read [rpc/README.md](../rpc/README.md) carefully to know more about writing your own handlers for
* Clio.

adding the .. to the example shows that the 1.10.0 version works and the 1.11.0 version doesn't.

So now I'm able to reproduce the problem.

[godexsoft]

That's my bad - should have reverted my experiments before copying the files. Glad you were able to reproduce 👍

[albert-github]

I did a bisection and git:

15e5493cc4e79ec44d55d1ef1f4d5d2bc08290f4 is the first bad commit

Date:   Sun May 5 13:21:58 2024 +0200

    Avoid double calls to resolve references

 src/docnode.cpp   | 18 ++++++------------
 src/docparser.cpp | 19 +++++++++++++------
 src/docparser.h   |  1 +
 src/docparser_p.h |  1 +
 src/util.cpp      | 50 +-------------------------------------------------
 src/util.h        |  3 ---
 6 files changed, 22 insertions(+), 70 deletions(-)

(e8bd0b3b5214fe8687408689b2dc6c1959ea0373is still OK).

I suspect that in the optimization a . is replaced by :: ant thus the reference cannot be resolved anymore and the target input of DocRef::DocRef can be a filename.

As far as I can tell the line:

if (sec==nullptr && parser->context.lang==SrcLangExt::Markdown)

is there problem now, the old construct was:

  SrcLangExt lang = getLanguageFromFileName(target);
  if (sec==nullptr && lang==SrcLangExt::Markdown) // lookup as markdown file

[albert-github]

I've just pushed a proposed patch, pull request #10908