Skip to content
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

Missing 'Referenced by' links for macros (C/C++) #10343

Closed
HeikoAtWork opened this issue Oct 4, 2023 · 6 comments
Closed

Missing 'Referenced by' links for macros (C/C++) #10343

HeikoAtWork opened this issue Oct 4, 2023 · 6 comments

Comments

@HeikoAtWork
Copy link

Describe the bug
In the HTML documentation generated by Doxygen 1.9.8 from C/C++ source code the 'Referenced by' links for macros (#define ...) are missing if REFERENCED_BY_RELATION = YES is set in the configuration. These links have been there in the documentation generated by older Doxygen versions (e.g. Doxygen 1.6.2).

Expected behavior
If REFERENCED_BY_RELATION = YES is set in the Doxygen configuration (Doxyfile) then 'Referenced by' links should be generated also for C/C++ macros (#define ...) in the HTML output.

Screenshots
Doxygen 1.9.8: Macro documentation without referenced-by links
Doxygen 1 9 8 macro documentation without referenced-by links

Doxygen 1.6.2: Macro documentation with referenced-by links
Doxygen 1 6 2 macro documentation with referenced-by links

Version
Doxygen version 1.9.8 on Windows 10, 64 bit.

@albert-github albert-github added needinfo reported bug is incomplete, please add additional info C/C++ labels Oct 4, 2023
@HeikoAtWork
Copy link
Author

HelloWorldExampleWithMacro.zip

Here is a simple example explaining the issue (including C code, Doxyfile and HTML output of Doxygen 1.6.2 and 1.8.9). For the HELLO_TEXT macro therein the old Doxygen 1.6.2 generates a "Referenced by ..." link. This link however is missing in the HTML output generated by Doxygen 1.9.8.

@albert-github albert-github added bug and removed needinfo reported bug is incomplete, please add additional info labels Oct 5, 2023
@albert-github
Copy link
Collaborator

Looks like that the information vanished between 1.8.14 and 1.8.15, have to do some bisecting...
(I did try yesterday something as well but apparently didn't send the comment but only set the labels).

@albert-github
Copy link
Collaborator

Did the bisecting and the result is:

0697535ad38ed122964c4673b102a8e30ad4369f is the first bad commit
commit 0697535ad38ed122964c4673b102a8e30ad4369f
Date:   Wed Oct 17 19:10:24 2018 +0200

    Add commands to handle referenced by relation and references relation

    Analogous to call graph and caller graph this patch provides an implementation for the referenced by relation and references relation.
    Providing the commands:
    - referencedbyrelation
    - hidereferencedbyrelation
    - referencesrelation
    - hidereferencesrelation

    Motivation is that some lists can get extremely large and also there is now more symmetry between the textual and graphical out.

Probably an extra call to a setting routine for macros is necessary, implementation was done analogous to call / caller graphs but macros are never shown here (and consequently probably the related call to referenced by relation is missing).

albert-github added a commit to albert-github/doxygen that referenced this issue Oct 6, 2023
Adding the settings for Referenced by relation and References relation.
@albert-github
Copy link
Collaborator

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

doxygen added a commit that referenced this issue Oct 6, 2023
issue #10343 Missing 'Referenced by' links for macros (C/C++)
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Oct 7, 2023
@albert-github
Copy link
Collaborator

Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release).

@doxygen
Copy link
Owner

doxygen commented Dec 25, 2023

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.10.0.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 25, 2023
@doxygen doxygen closed this as completed Dec 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants