Skip to content
Snippets Groups Projects

build: Fix Doxygen warnings.

Merged Elizabeth Figura requested to merge zfigura/vkd3d:mr2 into master
1 unresolved thread

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
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 Mascellani
  • You 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?

  • 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...

  • You 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?

  • Couldn't we just add a dummy docstring to the function we don't intend to document further?

    We can, but the annoying thing is we need to add a dummy string to every parameter. That's basically what's being complained about here.

  • It's probably what I would do, but as I said I don't really have a strong opinion, so whatever is fine for me.

  • Please register or sign in to reply
  • 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.

  • Giovanni Mascellani approved this merge request

    approved this merge request

  • 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.

  • Henri Verbeet approved this merge request

    approved this merge request

  • Henri Verbeet added 35 commits

    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.

    Compare with previous version

  • Please register or sign in to reply
    Loading