Refactor the internal-api-docs Doxyfile #240

New issue

Closed

opened 2024-04-17 21:52:17 +00:00 by qyriad · 2 comments

qyriad commented

2024-04-17 21:52:17 +00:00

Owner

Brought to attention by @jade in CL836/build internal API docs with Meson, the doxygen.cfg file is fragile and relies on being in a specific working directory when doxygen is run, both to determine its source paths and its output paths, neither of which can be overridden in the command-line invocation of doxygen, so the config should really have a TOP_SRC variable or similar to make this not super fragile, but this was deferred from CL836 to a later change

Brought to attention by @jade in [CL836/build internal API docs with Meson](https://gerrit.lix.systems/c/lix/+/836/comment/4a5e13ee_ec2bf732/), the doxygen.cfg file is fragile and relies on being in a specific working directory when doxygen is run, both to determine its source paths and its output paths, neither of which can be overridden in the command-line invocation of doxygen, so the config should really have a TOP_SRC variable or similar to make this not super fragile, but this was deferred from CL836 to a later change

qyriad added the

devx

docs

E/easy

labels 2024-04-17 21:52:17 +00:00

qyriad self-assigned this 2024-04-17 21:52:17 +00:00

qyriad commented

2024-04-17 21:52:30 +00:00

Author

Owner

Self assigning but anyone else can feel free to take it before we get to it

lix-bot commented

2024-09-24 18:31:19 +00:00

Member

This issue was mentioned on Gerrit on the following CLs:

commit message in cl/1938 ("internal-api-docs: allow Doxygen to build regardless of workdir")

This issue was mentioned on Gerrit on the following CLs: * commit message in [cl/1938](https://gerrit.lix.systems/c/lix/+/1938) ("internal-api-docs: allow Doxygen to build regardless of workdir")