Providing explicit documentation for throwing an exception when no bu… #21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AerialMantis
requested changes
Aug 3, 2017
placeholder_accessors/index.md
Outdated
|
|
||
| ```cpp | ||
| bool accessor<T, Dim, Mode, Target, Placeholder>::has_buffer() const noexcept | ||
| { |
There was a problem hiding this comment.
We don't need to define the member function here, just provide the declaration and then describe what they should do.
placeholder_accessors/index.md
Outdated
|
|
||
| void handler::require(buffer<T, dim> b, | ||
| accessor<T, dim, mode, target, access::placeholder::true_t> a) | ||
| { |
There was a problem hiding this comment.
We don't need to define the member function here, just provide the declaration and then describe what they should do.
placeholder_accessors/index.md
Outdated
|
|
||
| ### `accessor`s without buffers |
There was a problem hiding this comment.
accessors without buffers -> Placeholder accessor without a buffer.
placeholder_accessors/index.md
Outdated
|
|
||
| ### `accessor`s without buffers | ||
|
|
||
| If a placeholder accessor is not tied to a buffer within a command group, then |
There was a problem hiding this comment.
If a placeholder accessor -> If a placeholder accessor which was not constructed with a buffer.
cjdb
commented
Aug 3, 2017
Ruyk
requested changes
Aug 3, 2017
placeholder_accessors/index.md
Outdated
| an exception is thrown. | ||
| If a placeholder accessor which was not constructed with a buffer is not tied | ||
| to a buffer within a command group, then an exception is thrown. An accessor | ||
| can be checked for a buffer using `has_buffer()`. |
There was a problem hiding this comment.
for the existence of an associated buffer
placeholder_accessors/index.md
Outdated
| ``` | ||
| |Member function |Description | | ||
| |-----------------|---------------------------------------------------------| | ||
| |bool has_buffer()|Returns true if the accessor is associated with a buffer,| |
There was a problem hiding this comment.
bool has_buffer() const to prevent side effects
|
@Ruyk for your review |
Ruyk
approved these changes
Aug 3, 2017
AerialMantis
approved these changes
Aug 3, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…ffer exists.