diff --git a/include/bio/alphabet/aminoacid/aminoacid_base.hpp b/include/bio/alphabet/aminoacid/aminoacid_base.hpp index b01293856..4fd5e8cc0 100644 --- a/include/bio/alphabet/aminoacid/aminoacid_base.hpp +++ b/include/bio/alphabet/aminoacid/aminoacid_base.hpp @@ -106,7 +106,7 @@ class aminoacid_base : public aminoacid_empty_base, public base valid_char_table = []() constexpr { static_assert(sizeof(char_type) == 1, "This table is unusable for char types larger than 1 byte."); diff --git a/include/bio/alphabet/composite/tuple_base.hpp b/include/bio/alphabet/composite/tuple_base.hpp index c92874838..c929b9552 100644 --- a/include/bio/alphabet/composite/tuple_base.hpp +++ b/include/bio/alphabet/composite/tuple_base.hpp @@ -159,8 +159,7 @@ class tuple_base : * \{ * \attention Please do not directly use the CRTP base class. The functions * are only public for the usage in their derived classes (e.g. - * bio::alphabet::qualified, bio::alphabet::masked, bio::alphabet::structure_rna and - * bio::alphabet::structure_aa). + * bio::alphabet::qualified, bio::alphabet::masked). */ //!\brief Construction from initialiser-list. constexpr tuple_base(component_types... components) noexcept @@ -171,9 +170,11 @@ class tuple_base : /*!\brief Construction via a value of one of the components. * \tparam component_type Must be one uniquely contained in the type list of the composite. * \param alph The value of a component that should be assigned. + * \details * * Note: Since the tuple_base is a CRTP base class, we show the working examples * with one of its derived classes (bio::alphabet::qualified). + * * \include test/snippet/alphabet/composite/tuple_base_value_construction.cpp * */ @@ -190,6 +191,7 @@ class tuple_base : * \tparam indirect_component_type Type that models bio::alphabet::weakly_assignable_from for * one of the component types. * \param alph The value that should be assigned. + * \details * * Note that the value will be assigned to the **FIRST** type T that fulfils * `assignable_from`, regardless if other types are also @@ -197,6 +199,7 @@ class tuple_base : * * Note: Since the tuple_base is a CRTP base class, we show the working examples * with one of its derived classes (bio::alphabet::qualified). + * * \include test/snippet/alphabet/composite/tuple_base_subtype_construction.cpp * */ @@ -234,9 +237,11 @@ class tuple_base : /*!\brief Assignment via a value of one of the components. * \tparam component_type One of the component types. Must be uniquely contained in the type list of the composite. * \param alph The value of a component that should be assigned. + * \details * * Note: Since the tuple_base is a CRTP base class, we show the working examples * with one of its derived classes (bio::alphabet::qualified). + * * \include test/snippet/alphabet/composite/tuple_base_value_assignment.cpp * */ @@ -254,9 +259,11 @@ class tuple_base : * \tparam indirect_component_type Type that models bio::alphabet::weakly_assignable_from for * one of the component types. * \param alph The value of a component that should be assigned. + * \details * * Note: Since the tuple_base is a CRTP base class, we show the working examples * with one of its derived classes (bio::alphabet::qualified). + * * \include test/snippet/alphabet/composite/tuple_base_subtype_assignment.cpp * */ @@ -334,7 +341,7 @@ class tuple_base : return component_proxy{l}; } - /*!\copybrief get + /*!\brief Tuple-like access to the contained components. * \tparam type Return the element of specified type; only available if the type is unique in the set of components. * \returns A proxy to the contained element that models the same alphabets concepts and supports assignment. * @@ -348,7 +355,7 @@ class tuple_base : return get>(l); } - /*!\copybrief get + /*!\brief Tuple-like access to the contained components. * \tparam index Return the i-th element. * \returns A copy of the contained element. * @@ -363,7 +370,7 @@ class tuple_base : return bio::alphabet::assign_rank_to(l.to_component_rank(), t{}); } - /*!\copybrief get + /*!\brief Tuple-like access to the contained components. * \tparam type Return the element of specified type; only available if the type is unique in the set of components. * \returns A copy of the contained element. * @@ -420,7 +427,7 @@ class tuple_base : return get(lhs) == rhs; } - //!\copydoc operator==(derived_type_t const lhs, indirect_component_type const rhs) + //!\copydoc bio::alphabet::tuple_base::operator==(derived_type_t const lhs, indirect_component_type const rhs) template derived_type_t, typename indirect_component_type> //!\cond requires(detail::tuple_concept_guard && diff --git a/include/bio/alphabet/nucleotide/nucleotide_base.hpp b/include/bio/alphabet/nucleotide/nucleotide_base.hpp index fb7bed512..c4b23d2fa 100644 --- a/include/bio/alphabet/nucleotide/nucleotide_base.hpp +++ b/include/bio/alphabet/nucleotide/nucleotide_base.hpp @@ -134,7 +134,7 @@ class nucleotide_base : public base } private: - //!\brief Implementation of #char_is_valid(). + //!\brief Implementation of char_is_valid(). static constexpr std::array valid_char_table = []() constexpr { static_assert(sizeof(char_type) == 1, "This table is unusable for char types larger than 1 byte."); diff --git a/include/bio/ranges/container/bitcompressed_vector.hpp b/include/bio/ranges/container/bitcompressed_vector.hpp index 25261a4e5..7f5f60552 100644 --- a/include/bio/ranges/container/bitcompressed_vector.hpp +++ b/include/bio/ranges/container/bitcompressed_vector.hpp @@ -964,7 +964,7 @@ class bitcompressed_vector */ constexpr void swap(bitcompressed_vector & rhs) noexcept { std::swap(*this, rhs); } - //!\copydoc swap() + //!\copydoc #swap(bitcompressed_vector & rhs) constexpr void swap(bitcompressed_vector && rhs) noexcept { std::swap(*this, rhs); } /*!\brief Swap contents with another instance. diff --git a/include/bio/ranges/container/small_string.hpp b/include/bio/ranges/container/small_string.hpp index 802a77a53..9006d2c37 100644 --- a/include/bio/ranges/container/small_string.hpp +++ b/include/bio/ranges/container/small_string.hpp @@ -179,7 +179,7 @@ class small_string : public small_vector data_[0] = '\0'; } - //!\copydoc bio::ranges::small_vector::push_back(value_type const value) + //!\copydoc bio::ranges::small_vector::push_back constexpr void push_back(char const value) noexcept { assert(sz < capacity_); @@ -196,10 +196,11 @@ class small_string : public small_vector data_[sz] = '\0'; } - //!\copydoc bio::ranges::small_vector::resize(size_type const) + //!\copydoc bio::ranges::small_vector::resize constexpr void resize(size_type const count) noexcept { resize(count, '\0'); } - //!\copydoc bio::ranges::small_vector::resize(size_type const, value_type const value) + //!\copydoc bio::ranges::small_vector::resize + //!\param[in] value Append copies of value when resizing. constexpr void resize(size_type const count, char const value) noexcept { assert(count <= capacity_); diff --git a/include/bio/ranges/container/small_vector.hpp b/include/bio/ranges/container/small_vector.hpp index 3404ba784..085866ad4 100644 --- a/include/bio/ranges/container/small_vector.hpp +++ b/include/bio/ranges/container/small_vector.hpp @@ -304,7 +304,7 @@ class small_vector /*!\name Iterators * \{ */ - //!\brief Returns the begin to the string. + //!\brief Returns the begin iterator of the vector. constexpr iterator begin() noexcept { return &data_[0]; } //!\copydoc bio::ranges::small_vector::begin() @@ -350,7 +350,7 @@ class small_vector return (*this)[i]; } - //!\copydoc at() + //!\copydoc bio::ranges::small_vector::at() const_reference at(size_type const i) const { if (i >= size()) // [[unlikely]] @@ -381,7 +381,7 @@ class small_vector return data_[i]; } - //!\copydoc operator[]() + //!\copydoc bio::ranges::small_vector::operator[]() constexpr const_reference operator[](size_type const i) const noexcept { assert(i < size()); @@ -407,7 +407,7 @@ class small_vector return (*this)[0]; } - //!\copydoc front() + //!\copydoc bio::ranges::small_vector::front() constexpr const_reference front() const noexcept { assert(size() > 0); @@ -433,7 +433,7 @@ class small_vector return (*this)[size() - 1]; } - //!\copydoc back() + //!\copydoc bio::ranges::small_vector::back() constexpr const_reference back() const noexcept { assert(size() > 0); @@ -443,7 +443,7 @@ class small_vector //!\brief Direct access to the underlying array. constexpr value_type * data() noexcept { return data_.data(); } - //!\copydoc data() + //!\copydoc bio::ranges::small_vector::data() constexpr value_type const * data() const noexcept { return data_.data(); } //!\} @@ -750,9 +750,9 @@ class small_vector sz = count; } - /*!\copybrief resize() - * \param value Append copies of value when resizing. - * \copydetails resize() + /*!\copybrief bio::ranges::small_vector::resize + * \param[in] value Append copies of value when resizing. + * \copydetails bio::ranges::small_vector::resize */ constexpr void resize(size_type const count, value_type const value) noexcept { diff --git a/include/bio/ranges/detail/inherited_iterator_base.hpp b/include/bio/ranges/detail/inherited_iterator_base.hpp index 6b79cf7bf..75e4ca35d 100644 --- a/include/bio/ranges/detail/inherited_iterator_base.hpp +++ b/include/bio/ranges/detail/inherited_iterator_base.hpp @@ -391,7 +391,7 @@ class inherited_iterator_base : //!\brief Cast this to derived type. constexpr derived_t * this_derived() { return static_cast(this); } - //!\copydoc this_derived + //!\overload constexpr derived_t const * this_derived() const { return static_cast(this); } //!\brief Cast this to base type. @@ -403,7 +403,7 @@ class inherited_iterator_base : return static_cast(this); } - //!\copydoc this_to_base + //!\overload constexpr base_t const * this_to_base() const { if constexpr (wrap_base) diff --git a/include/bio/ranges/detail/random_access_iterator.hpp b/include/bio/ranges/detail/random_access_iterator.hpp index 8d80508f7..0ac44a5cb 100644 --- a/include/bio/ranges/detail/random_access_iterator.hpp +++ b/include/bio/ranges/detail/random_access_iterator.hpp @@ -234,7 +234,7 @@ class random_access_iterator_base //!\brief Cast this to derived type. constexpr derived_t * this_derived() { return static_cast(this); } - //!\copydoc this_derived + //!\overload constexpr derived_t const * this_derived() const { return static_cast(this); } };