search

bfgroup / b2

B2 makes it easy to build C++ projects, everywhere.
https://www.bfgroup.xyz/b2/
Boost Software License 1.0
75 stars 228 forks source link

fix doxygen's treatment of source paths #403

Open grisumbras opened 1 month ago

grisumbras commented 1 month ago

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

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.

grisumbras commented 1 month ago

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