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

fix doxygen's treatment of source paths #403

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

grisumbras
Copy link
Contributor

Proposed changes

doxygen.headers-to-doxyfile creates a Doxygen configuration file and populates its INPUT value with the paths to its sources. But when doing so it does not take into account the full path to those sources, only the part that is used in the source name without the grist. The resulting file is only correct when either the provided path to a source is absolute, or when the path is relative to CWD. Some globbing functions return relative paths. And the sources for docs usually searched from the doc subdir, not from CWD.

This change fixes that issue by having headers-to-doxyfile to prefix paths to sources with their SEARCH variables.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)

Further comments

An alternative fix would be to make the paths which are put into the resulting Doxygen config file absolute. This change would be potentially slightly more disruptive, but has some potential benefits.

doxygen.headers-to-doxyfile creates a Doxygen configuration file and
populates its INPUT value with the paths to its sources. But when doing
so it does not take into account the full path to those sources, only
the part that is used in the source name without the grist. The
resulting file is only correct when either the provided path to a source is
absolute, or when the path is relative to CWD. Some globbing functions return
relative paths. And the sources for docs usually searched from the doc
subdir, not from CWD.

This change fixes that issue by having headers-to-doxyfile to prefix paths to
sources with their SEARCH variables.
@grisumbras
Copy link
Contributor Author

The failed Azure jobs don't appear to be related to my changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant