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

Documentation fixes

Browse Source
This commit is contained in:
Peter Dimov
2019-04-29 20:21:23 +03:00
parent f0f8e398d6
commit b7ffb62e09
2 changed files with 4 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/endian/arithmetic.adoc
View File

@ -394,8 +394,7 @@ endian_arithmetic() = default; // C++03: endian(){}
[none] [none]
* {blank} * {blank}
+ +
Effects:: Constructs an uninitialized object of type Effects:: Constructs an uninitialized object.
`endian_arithmetic<E, T, n_bits, A>`.
``` ```
endian_arithmetic(T v); endian_arithmetic(T v);
@ -403,8 +402,7 @@ endian_arithmetic(T v);
[none] [none]
* {blank} * {blank}
+ +
Effects:: Constructs an object of type `endian_arithmetic<E, T, n_bits, A>`. Postcondition:: `*this == v`.
Postcondition:: `x == v,` where `x` is the constructed object.
``` ```
endian_arithmetic& operator=(T v); endian_arithmetic& operator=(T v);
@ -412,7 +410,7 @@ endian_arithmetic& operator=(T v);
[none] [none]
* {blank} * {blank}
+ +
Postcondition:: `x == v,` where `x` is the constructed object. Postcondition:: `*this == v`.
Returns:: `*this`. Returns:: `*this`.
``` ```

10
doc/endian/buffers.adoc
View File

@ -378,8 +378,7 @@ endian_buffer() noexcept = default;
[none] [none]
* {blank} * {blank}
+ +
Effects:: Constructs an uninitialized object of type `endian_buffer<Order, T, Effects:: Constructs an uninitialized object.
Nbits, Align>`.
``` ```
explicit endian_buffer(T v) noexcept; explicit endian_buffer(T v) noexcept;
@ -387,11 +386,8 @@ explicit endian_buffer(T v) noexcept;
[none] [none]
* {blank} * {blank}
+ +
Effects:: Constructs an object of type `endian_buffer<Order, T, Nbits, Align>`.
Postcondition:: `value() == v & mask`, where `mask` is a constant of type Postcondition:: `value() == v & mask`, where `mask` is a constant of type
`value_type` with `Nbits` low-order bits set to one. `value_type` with `Nbits` low-order bits set to one.
Remarks:: If `Align` is `align::yes` then endianness conversion, if required,
is performed by `boost::endian::endian_reverse`.
``` ```
endian_buffer& operator=(T v) noexcept; endian_buffer& operator=(T v) noexcept;
@ -402,8 +398,6 @@ endian_buffer& operator=(T v) noexcept;
Postcondition:: `value() == v & mask`, where `mask` is a constant of type Postcondition:: `value() == v & mask`, where `mask` is a constant of type
`value_type` with `Nbits` low-order bits set to one. `value_type` with `Nbits` low-order bits set to one.
Returns:: `*this`. Returns:: `*this`.
Remarks:: If `Align` is `align::yes` then endianness conversion, if required, is
performed by `boost::endian::endian_reverse`.
``` ```
value_type value() const noexcept; value_type value() const noexcept;
@ -413,8 +407,6 @@ value_type value() const noexcept;
+ +
Returns:: `endian_value`, converted to `value_type`, if required, and having the Returns:: `endian_value`, converted to `value_type`, if required, and having the
endianness of the native platform. endianness of the native platform.
Remarks:: If `Align` is `align::yes` then endianness conversion, if required, is
performed by `boost::endian::endian_reverse`.
``` ```
const char* data() const noexcept; const char* data() const noexcept;