We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Why does documentation omits method’s input variable’s names in Synopsis section?
Synopsis
For example: https://www.boost.org/doc/libs/1_69_0/doc/html/boost/interprocess/mapped_region.html
class mapped_region { ... bool flush(std::size_t = 0, std::size_t = 0, bool = true); ... }
This looks bad for me, because there’s no way to understand the meaning of size_ts or bool. I think this synopsis doesn’t help as much as it could.
size_t
bool
Hopefully, there is more appropriate description below:
bool flush(std::size_t mapping_offset = 0, std::size_t numbytes = 0, bool async = true);
I think it would be good to have this in synopsis.
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Why does documentation omits method’s input variable’s names in
Synopsis
section?For example:
https://www.boost.org/doc/libs/1_69_0/doc/html/boost/interprocess/mapped_region.html
This looks bad for me, because there’s no way to understand the meaning of
size_t
s orbool
. I think this synopsis doesn’t help as much as it could.Hopefully, there is more appropriate description below:
I think it would be good to have this in synopsis.
The text was updated successfully, but these errors were encountered: