Skip to content

[doc] Document the format tag without a \param - #794

Merged
mloskot merged 1 commit into
boostorg:developfrom
karpovantonme:docs/unnamed-tag-param
Aug 5, 2026
Merged

[doc] Document the format tag without a \param#794
mloskot merged 1 commit into
boostorg:developfrom
karpovantonme:docs/unnamed-tag-param

Conversation

@karpovantonme

Copy link
Copy Markdown
Contributor

Both read_image_info overloads document a tag parameter, and the argument it refers to has no name:

/// \param file It's a device. Must satisfy is_adaptable_input_device metafunction.
/// \param tag  Defines the image format. Must satisfy is_format_tag metafunction.
template <typename Device, typename FormatTag>
auto read_image_info(Device& file, FormatTag const&, ...)

Doxygen cannot attach a \param to an unnamed argument, so it reports tag as a parameter that does not exist and the format tag ends up undocumented either way.

Two ways to fix it, and I picked the second:

  • name the argument tag. It is never used in the body, so this would produce an unused-parameter warning, and every other FormatTag argument across io/ is unnamed as well, so it would also break with the surrounding style;
  • keep the declaration and move the sentence into the description. That is what this does.

The wording is the same as before, only the position changed.

Both read_image_info overloads carry \param tag, but the FormatTag
argument has no name in the declaration and Doxygen cannot attach a
\param to one. Naming it would produce an unused parameter, and every
other FormatTag argument across io/ is unnamed too, so the explanation
moves into the description instead.

@mloskot mloskot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@mloskot
mloskot merged commit 5dc528c into boostorg:develop Aug 5, 2026
31 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants