build: Fix Doxygen warnings.
Merge request reports
Activity
10 10 EXTRACT_STATIC = YES 11 11 QUIET = YES 12 12 WARN_IF_UNDOCUMENTED = NO 13 WARN_IF_INCOMPLETE_DOC = NO I can't say I have strong opinions, but do you know whether there is a way to disable warnings for specific functions? In general it would seem helpful to have this kind of warning.
Edited by Giovanni MascellaniYou can disable output for specific functions, but I think that prevents them from showing up in the documentation entirely. I'm not sure we want that?
No, I don't think so.
Then again, it may be better to just disable vkd3d_utils.h and keep the warning around for the rest of the code. There are very few things that seem worth documenting in there...
Well, even if there is not a lot to document there, given that that's still a header file that we're distributing, I think it should appear in the documentation, otherwise it might be confusing for readers who have to look to the documentation sometimes and to the headers other times. So this is not something I'd like anyway.
Couldn't we just add a dummy docstring to the function we don't intend to document further?
BTW, since we already do that for the code, we might want to set warning as errors for Doxygen too: https://www.doxygen.nl/manual/config.html#cfg_warn_as_error.
BTW, since we already do that for the code, we might want to set warning as errors for Doxygen too: https://www.doxygen.nl/manual/config.html#cfg_warn_as_error.
Yeah, I think we want that, but only on the CI.
added 35 commits
-
51580522...127ae6cf - 31 commits from branch
wine:master
- 9fbf6467 - build: Do not warn on incomplete documentation.
- 46831861 - vkd3d-shader: Mention the structure name when referring to a struct field.
- 30472460 - vkd3d-shader: Escape a hash in Doxygen documentation.
- f6a8cdf2 - vkd3d-shader: Do not use \ref for parameters.
Toggle commit list-
51580522...127ae6cf - 31 commits from branch