Skip to content
New issue

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

Boost documentation method’s input variable’s names in Synopsis #77

Open
mathbunnyru opened this issue Feb 15, 2019 · 0 comments
Open

Comments

@mathbunnyru
Copy link

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

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.

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.

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

No branches or pull requests

1 participant