fix doxygen's treatment of source paths #403
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
doxygen.headers-to-doxyfilecreates a Doxygen configuration file and populates itsINPUTvalue 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-doxyfileto prefix paths to sources with theirSEARCHvariables.Types of changes
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.