Skip to content

Fix the template parameter name in buffers_iterator_type - #3108

Open
karpovantonme wants to merge 1 commit into
boostorg:developfrom
karpovantonme:docs/tparam-name
Open

Fix the template parameter name in buffers_iterator_type#3108
karpovantonme wants to merge 1 commit into
boostorg:developfrom
karpovantonme:docs/tparam-name

Conversation

@karpovantonme

Copy link
Copy Markdown

One @tparam naming something the template does not take.

/** Type alias for the iterator type of a buffer sequence type.
    ...
    @tparam T The buffer sequence type to use.
*/
template <class BufferSequence>
using buffers_iterator_type = __see_below__;

The three other @tparam tags in this file, on buffers_type and its neighbours, all say BufferSequence, so this is the odd one out rather than a convention I am changing.

Not touched, in case you want it: http/message.hpp:284 documents @param args on a constructor taking Arg1&& arg1, ArgN&&... argn. Describing a pack collectively reads fine to me, and clang -Wdocumentation disagrees, so I left it as your call.

The block documents @tparam T while the template takes BufferSequence.
The three @tparam tags above it in the same file all name it correctly.
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