From b7ffb62e093715d784c5d649b8f040d2dbd919d5 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Mon, 29 Apr 2019 20:21:23 +0300 Subject: [PATCH] Documentation fixes --- doc/endian/arithmetic.adoc | 8 +++----- doc/endian/buffers.adoc | 10 +--------- 2 files changed, 4 insertions(+), 14 deletions(-) diff --git a/doc/endian/arithmetic.adoc b/doc/endian/arithmetic.adoc index 706e5d5..43c5e55 100644 --- a/doc/endian/arithmetic.adoc +++ b/doc/endian/arithmetic.adoc @@ -394,8 +394,7 @@ endian_arithmetic() = default; // C++03: endian(){} [none] * {blank} + -Effects:: Constructs an uninitialized object of type -`endian_arithmetic`. +Effects:: Constructs an uninitialized object. ``` endian_arithmetic(T v); @@ -403,8 +402,7 @@ endian_arithmetic(T v); [none] * {blank} + -Effects:: Constructs an object of type `endian_arithmetic`. -Postcondition:: `x == v,` where `x` is the constructed object. +Postcondition:: `*this == v`. ``` endian_arithmetic& operator=(T v); @@ -412,7 +410,7 @@ endian_arithmetic& operator=(T v); [none] * {blank} + -Postcondition:: `x == v,` where `x` is the constructed object. +Postcondition:: `*this == v`. Returns:: `*this`. ``` diff --git a/doc/endian/buffers.adoc b/doc/endian/buffers.adoc index c09d92a..797d040 100644 --- a/doc/endian/buffers.adoc +++ b/doc/endian/buffers.adoc @@ -378,8 +378,7 @@ endian_buffer() noexcept = default; [none] * {blank} + -Effects:: Constructs an uninitialized object of type `endian_buffer`. +Effects:: Constructs an uninitialized object. ``` explicit endian_buffer(T v) noexcept; @@ -387,11 +386,8 @@ explicit endian_buffer(T v) noexcept; [none] * {blank} + -Effects:: Constructs an object of type `endian_buffer`. Postcondition:: `value() == v & mask`, where `mask` is a constant of type `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; @@ -402,8 +398,6 @@ endian_buffer& operator=(T v) noexcept; Postcondition:: `value() == v & mask`, where `mask` is a constant of type `value_type` with `Nbits` low-order bits set to one. 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; @@ -413,8 +407,6 @@ value_type value() const noexcept; + Returns:: `endian_value`, converted to `value_type`, if required, and having the 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;