doxygen complains STIR_LOCAL-NOTFOUND
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 160
- Forks
- 113
- Avg merge
- 12d 15h
- Merged PRs (30d)
- 1
Description
If STIR_LOCAL is not set, when running doxygen, we get
warning tag INPUT: input source `STIR_LOCAL-NOTFOUND' does not exist
Reason: Doxyfile.in uses STIR_LOCAL, while it should use a variable that is empty when STIR_LOCAL was not set. The following might work
if (NOT STIR_LOCAL)
# set to empty for substitution in Doxyfile.in
set(STIR_LOCAL "")
endif()
but it's a bit dangerous/confusing to do this. Might be better to introduce another variable.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with src/Doxyfile.in around the STIR_LOCAL reference at line 748 and inspect how the CMake configuration substitutes that variable. Run the Doxygen generation with STIR_LOCAL unset and set, then confirm the warning disappears when unset while the configured local path still works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100