-
Notifications
You must be signed in to change notification settings - Fork 10
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
fields/message max size #76
fields/message max size #76
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #76 +/- ##
===========================================
+ Coverage 88.09% 88.22% +0.12%
===========================================
Files 78 78
Lines 4260 4314 +54
===========================================
+ Hits 3753 3806 +53
- Misses 507 508 +1
... and 6 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
GCOVR code coverage report https://76.http-proto.prtest.cppalliance.org/gcovr/index.html |
include/boost/http_proto/request.hpp
Outdated
BOOST_HTTP_PROTO_DECL | ||
explicit | ||
request( | ||
std::size_t size); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well the parameter needs a javadoc. here and everywhere else
f2e13c1
to
247c0f7
Compare
GCOVR code coverage report https://76.http-proto.prtest.cppalliance.org/gcovr/index.html |
bc9fa35
to
2c416c9
Compare
include/boost/http_proto/request.hpp
Outdated
The storage is also used internally to store | ||
instances of an implementation-defined type. | ||
`storage_size` will be aligned accordingly | ||
(currently the alignment requirement is 4). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
kind of ugly to use the term storage_size
in every consecutive sentence...
include/boost/http_proto/request.hpp
Outdated
Passing an initial storage size of `0` does not | ||
throw and the maximum capacity is set to an | ||
implementation-defined limit observable via | ||
`max_capacity_in_bytes()`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can say @ref max_capacity_in_bytes
instead and it will be linked
include/boost/http_proto/request.hpp
Outdated
@param storage_size The initial and final size of | ||
the storage allocated to hold both the serialized | ||
header and instances of a per-field | ||
implementation-defined type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You don't have to be verbose and repeat information which was already given in the description. Better to only explain things once, this way if you ever have to change the javadoc you can't forget to edit it everywhere.
2c416c9
to
65c7ce0
Compare
closes #68