feedc0de/boost_endian
1
0
Fork 0
forked from boostorg/endian
Code Pull Requests Activity

Update documentation for data()

Browse Source
This commit is contained in:
Peter Dimov
2019-10-16 00:20:58 +03:00
parent 51f095f019
commit b2faa783ad
3 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/endian/arithmetic.adoc
View File

@ -244,7 +244,8 @@ namespace boost
endian_arithmetic& operator=(T v) noexcept; endian_arithmetic& operator=(T v) noexcept;
operator value_type() const noexcept; operator value_type() const noexcept;
value_type value() const noexcept; // for exposition; see endian_buffer value_type value() const noexcept; // for exposition; see endian_buffer
const char* data() const noexcept; // for exposition; see endian_buffer unsigned char* data() noexcept; // for exposition; see endian_buffer
unsigned char const* data() const noexcept; // for exposition; see endian_buffer
// arithmetic operations // arithmetic operations
// note that additional operations are provided by the value_type // note that additional operations are provided by the value_type

12
doc/endian/buffers.adoc
View File

@ -231,12 +231,13 @@ namespace boost
explicit endian_buffer(T v) noexcept; explicit endian_buffer(T v) noexcept;
endian_buffer& operator=(T v) noexcept; endian_buffer& operator=(T v) noexcept;
value_type value() const noexcept; value_type value() const noexcept;
const char* data() const noexcept; unsigned char* data() noexcept;
unsigned char const* data() const noexcept;
private: private:
unsigned char value_[ Nbits / CHAR_BIT]; // exposition only unsigned char value_[Nbits / CHAR_BIT]; // exposition only
}; };
// stream inserter // stream inserter
@ -425,7 +426,10 @@ value_type value() const noexcept;
Returns:: `endian_load<T, Nbits/8, Order>( value_ )`. Returns:: `endian_load<T, Nbits/8, Order>( value_ )`.
``` ```
const char* data() const noexcept; unsigned char* data() noexcept;
```
```
unsigned char const* data() const noexcept;
``` ```
[none] [none]
* {blank} * {blank}

1
doc/endian/changelog.adoc
View File

@ -16,6 +16,7 @@ http://www.boost.org/LICENSE_1_0.txt
on GCC and Clang on GCC and Clang
* Added convenience load and store functions * Added convenience load and store functions
* Added floating point convenience typedefs * Added floating point convenience typedefs
* Added a non-const overload of `data()`; changed its return type to `unsigned char*`
## Changes in 1.71.0 ## Changes in 1.71.0