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

Update documentation

Browse Source
This commit is contained in:
Peter Dimov
2020-10-06 19:42:08 +03:00
parent 7832a88828
commit 3853f80886
1 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/endian/arithmetic.adoc
View File

@ -231,7 +231,6 @@ namespace boost
template <order Order, class T, std::size_t n_bits, template <order Order, class T, std::size_t n_bits,
align Align = align::no> align Align = align::no>
class endian_arithmetic class endian_arithmetic
: public endian_buffer<Order, T, n_bits, Align>
{ {
public: public:
@ -244,9 +243,9 @@ 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;
unsigned char* data() noexcept; // for exposition; see endian_buffer unsigned char* data() noexcept;
unsigned char const* data() const noexcept; // for exposition; see endian_buffer unsigned char const* data() const noexcept;
// arithmetic operations // arithmetic operations
// note that additional operations are provided by the value_type // note that additional operations are provided by the value_type
@ -433,6 +432,25 @@ endian_arithmetic& operator=(T v) noexcept;
Effects:: See `endian_buffer::operator=(T)`. Effects:: See `endian_buffer::operator=(T)`.
Returns:: `*this`. Returns:: `*this`.
```
value_type value() const noexcept;
```
[none]
* {blank}
+
Returns:: See `endian_buffer::value()`.
```
unsigned char* data() noexcept;
```
```
unsigned char const* data() const noexcept;
```
[none]
* {blank}
+
Returns:: See `endian_buffer::data()`.
``` ```
operator T() const noexcept; operator T() const noexcept;
``` ```