Minor doxygen annotation changes #3

nemothenoone · nemothenoone · commit db755a78fcaf · 2020-03-07T02:50:45.000+03:00
diff --git a/docs/concepts.md b/docs/concepts.md
@@ -28,8 +28,8 @@ The following static data member definitions must be valid and have their specif
 |---------------------------|------------------|-------------------------------|
 |```X::encoded_block_values```|```std::size_t```|```Integral``` amount of values in ```EncodedBlock```|
 |```X::decoded_block_values```|```std::size_t```|```Integral``` amount of values in ```DecodedBlock```|
-|```X::encoded_block_bits```|```std::size_t```|```Integral``` amount of bits in ```EncodedBlock```|
-|```X::decoded_block_bits```|```std::size_t```|```Integral``` amount of bits in ```DecodedBlock```|
+|```X::encoded_block_bits```|```std::size_t```|```Integral``` bits amount in ```EncodedBlock```|
+|```X::decoded_block_bits```|```std::size_t```|```Integral``` bits amount in ```DecodedBlock```|
 
 The following expressions must be valid and have their specified effects
 
diff --git a/include/nil/crypto3/codec/algorithm/codec.hpp b/include/nil/crypto3/codec/algorithm/codec.hpp
@@ -17,7 +17,7 @@ namespace nil {
              * @addtogroup codec Encoding & Decoding
              *
              * @addtogroup codec_algorithms Algorithms
-             * @ingroup codec
+             * @addtogroup codec
              * @brief Encoding algorithms are meant to provide encoding interface similar to STL algorithms' one.
              */
         }
diff --git a/include/nil/crypto3/codec/algorithm/decode.hpp b/include/nil/crypto3/codec/algorithm/decode.hpp
@@ -22,7 +22,7 @@ namespace nil {
              * @addtogroup codec Encoding & Decoding
              *
              * @addtogroup codec_algorithms Algorithms
-             * @ingroup codec
+             * @addtogroup codec
              * @brief Algorithms are meant to provide decoding interface similar to STL algorithms' one.
              */
         }
@@ -32,7 +32,7 @@ namespace nil {
          * in the range, defined by [first, last), and inserts the result to
          * another range beginning at out.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Decoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -64,7 +64,7 @@ namespace nil {
          * type convertible to the type satisfying SequenceContainer with the value
          * type satisfying Integral concept requirements.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Decoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -95,7 +95,7 @@ namespace nil {
          * in the range, defined by rng and inserts the result to destination
          * range beginning at out.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Decoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -125,7 +125,7 @@ namespace nil {
          * in the range, defined by rng and inserts the result to destination
          * range beginning at out.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Decoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -154,7 +154,7 @@ namespace nil {
          * in the range, defined by rng and inserts the result to destination
          * range beginning at out.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Decoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -184,7 +184,7 @@ namespace nil {
          * type convertible to the type satisfying SequenceContainer with the value
          * type satisfying Integral concept requirements.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Decoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
diff --git a/include/nil/crypto3/codec/algorithm/encode.hpp b/include/nil/crypto3/codec/algorithm/encode.hpp
@@ -24,7 +24,7 @@ namespace nil {
          * in the range, defined by [first, last), and inserts the result to
          * another range beginning at out.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Encoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -56,7 +56,7 @@ namespace nil {
          * type convertible to the type satisfying SequenceContainer with the value
          * type satisfying Integral concept requirements.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Encoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -86,7 +86,7 @@ namespace nil {
          * in the range, defined by [first, last) and returns the result with type
          * satisfying AccumulatorSet requirements.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Encoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -117,7 +117,7 @@ namespace nil {
          * in the range, defined by rng and inserts the result to destination
          * range beginning at out.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Encoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -147,7 +147,7 @@ namespace nil {
          * in the range, defined by rng and inserts the result to destination
          * range beginning at out.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Encoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.
@@ -177,7 +177,7 @@ namespace nil {
          * type convertible to the type satisfying SequenceContainer with the value
          * type satisfying Integral concept requirements.
          *
-         * @ingroup codec_algorithms
+         * @addtogroup codec_algorithms
          *
          * @tparam Encoder Must meet the requirements of Codec which determines the
          * particular algorithm to be used with range given.

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ namespace nil {`
`17`	`17`	`* @addtogroup codec Encoding & Decoding`
`18`	`18`	`*`
`19`	`19`	`* @addtogroup codec_algorithms Algorithms`
`20`		`- * @ingroup codec`
	`20`	`+ * @addtogroup codec`
`21`	`21`	`* @brief Encoding algorithms are meant to provide encoding interface similar to STL algorithms' one.`
`22`	`22`	`*/`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ namespace nil {`
`22`	`22`	`* @addtogroup codec Encoding & Decoding`
`23`	`23`	`*`
`24`	`24`	`* @addtogroup codec_algorithms Algorithms`
`25`		`- * @ingroup codec`
	`25`	`+ * @addtogroup codec`
`26`	`26`	`* @brief Algorithms are meant to provide decoding interface similar to STL algorithms' one.`
`27`	`27`	`*/`
`28`	`28`	`}`
`@@ -32,7 +32,7 @@ namespace nil {`
`32`	`32`	`* in the range, defined by [first, last), and inserts the result to`
`33`	`33`	`* another range beginning at out.`
`34`	`34`	`*`
`35`		`- * @ingroup codec_algorithms`
	`35`	`+ * @addtogroup codec_algorithms`
`36`	`36`	`*`
`37`	`37`	`* @tparam Decoder Must meet the requirements of Codec which determines the`
`38`	`38`	`* particular algorithm to be used with range given.`
`@@ -64,7 +64,7 @@ namespace nil {`
`64`	`64`	`* type convertible to the type satisfying SequenceContainer with the value`
`65`	`65`	`* type satisfying Integral concept requirements.`
`66`	`66`	`*`
`67`		`- * @ingroup codec_algorithms`
	`67`	`+ * @addtogroup codec_algorithms`
`68`	`68`	`*`
`69`	`69`	`* @tparam Decoder Must meet the requirements of Codec which determines the`
`70`	`70`	`* particular algorithm to be used with range given.`
`@@ -95,7 +95,7 @@ namespace nil {`
`95`	`95`	`* in the range, defined by rng and inserts the result to destination`
`96`	`96`	`* range beginning at out.`
`97`	`97`	`*`
`98`		`- * @ingroup codec_algorithms`
	`98`	`+ * @addtogroup codec_algorithms`
`99`	`99`	`*`
`100`	`100`	`* @tparam Decoder Must meet the requirements of Codec which determines the`
`101`	`101`	`* particular algorithm to be used with range given.`
`@@ -125,7 +125,7 @@ namespace nil {`
`125`	`125`	`* in the range, defined by rng and inserts the result to destination`
`126`	`126`	`* range beginning at out.`
`127`	`127`	`*`
`128`		`- * @ingroup codec_algorithms`
	`128`	`+ * @addtogroup codec_algorithms`
`129`	`129`	`*`
`130`	`130`	`* @tparam Decoder Must meet the requirements of Codec which determines the`
`131`	`131`	`* particular algorithm to be used with range given.`
`@@ -154,7 +154,7 @@ namespace nil {`
`154`	`154`	`* in the range, defined by rng and inserts the result to destination`
`155`	`155`	`* range beginning at out.`
`156`	`156`	`*`
`157`		`- * @ingroup codec_algorithms`
	`157`	`+ * @addtogroup codec_algorithms`
`158`	`158`	`*`
`159`	`159`	`* @tparam Decoder Must meet the requirements of Codec which determines the`
`160`	`160`	`* particular algorithm to be used with range given.`
`@@ -184,7 +184,7 @@ namespace nil {`
`184`	`184`	`* type convertible to the type satisfying SequenceContainer with the value`
`185`	`185`	`* type satisfying Integral concept requirements.`
`186`	`186`	`*`
`187`		`- * @ingroup codec_algorithms`
	`187`	`+ * @addtogroup codec_algorithms`
`188`	`188`	`*`
`189`	`189`	`* @tparam Decoder Must meet the requirements of Codec which determines the`
`190`	`190`	`* particular algorithm to be used with range given.`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ namespace nil {`
`24`	`24`	`* in the range, defined by [first, last), and inserts the result to`
`25`	`25`	`* another range beginning at out.`
`26`	`26`	`*`
`27`		`- * @ingroup codec_algorithms`
	`27`	`+ * @addtogroup codec_algorithms`
`28`	`28`	`*`
`29`	`29`	`* @tparam Encoder Must meet the requirements of Codec which determines the`
`30`	`30`	`* particular algorithm to be used with range given.`
`@@ -56,7 +56,7 @@ namespace nil {`
`56`	`56`	`* type convertible to the type satisfying SequenceContainer with the value`
`57`	`57`	`* type satisfying Integral concept requirements.`
`58`	`58`	`*`
`59`		`- * @ingroup codec_algorithms`
	`59`	`+ * @addtogroup codec_algorithms`
`60`	`60`	`*`
`61`	`61`	`* @tparam Encoder Must meet the requirements of Codec which determines the`
`62`	`62`	`* particular algorithm to be used with range given.`
`@@ -86,7 +86,7 @@ namespace nil {`
`86`	`86`	`* in the range, defined by [first, last) and returns the result with type`
`87`	`87`	`* satisfying AccumulatorSet requirements.`
`88`	`88`	`*`
`89`		`- * @ingroup codec_algorithms`
	`89`	`+ * @addtogroup codec_algorithms`
`90`	`90`	`*`
`91`	`91`	`* @tparam Encoder Must meet the requirements of Codec which determines the`
`92`	`92`	`* particular algorithm to be used with range given.`
`@@ -117,7 +117,7 @@ namespace nil {`
`117`	`117`	`* in the range, defined by rng and inserts the result to destination`
`118`	`118`	`* range beginning at out.`
`119`	`119`	`*`
`120`		`- * @ingroup codec_algorithms`
	`120`	`+ * @addtogroup codec_algorithms`
`121`	`121`	`*`
`122`	`122`	`* @tparam Encoder Must meet the requirements of Codec which determines the`
`123`	`123`	`* particular algorithm to be used with range given.`
`@@ -147,7 +147,7 @@ namespace nil {`
`147`	`147`	`* in the range, defined by rng and inserts the result to destination`
`148`	`148`	`* range beginning at out.`
`149`	`149`	`*`
`150`		`- * @ingroup codec_algorithms`
	`150`	`+ * @addtogroup codec_algorithms`
`151`	`151`	`*`
`152`	`152`	`* @tparam Encoder Must meet the requirements of Codec which determines the`
`153`	`153`	`* particular algorithm to be used with range given.`
`@@ -177,7 +177,7 @@ namespace nil {`
`177`	`177`	`* type convertible to the type satisfying SequenceContainer with the value`
`178`	`178`	`* type satisfying Integral concept requirements.`
`179`	`179`	`*`
`180`		`- * @ingroup codec_algorithms`
	`180`	`+ * @addtogroup codec_algorithms`
`181`	`181`	`*`
`182`	`182`	`* @tparam Encoder Must meet the requirements of Codec which determines the`
`183`	`183`	`* particular algorithm to be used with range given.`