Skip to content

Commit 23d7325

Browse files
committed
document begin end
1 parent 1631ade commit 23d7325

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

include/boost/multi/array_ref.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3425,8 +3425,8 @@ struct const_subarray<T, 1, ElementPtr, Layout> // NOLINT(fuchsia-multiple-inhe
34253425
#endif
34263426

34273427
public:
3428-
BOOST_MULTI_HD constexpr auto begin() const& -> const_iterator { return begin_aux_(); }
3429-
BOOST_MULTI_HD constexpr auto end() const& -> const_iterator { return end_aux_(); }
3428+
BOOST_MULTI_HD constexpr auto begin() const& -> const_iterator { return begin_aux_(); } ///< returns a iterator to the beginning
3429+
BOOST_MULTI_HD constexpr auto end() const& -> const_iterator { return end_aux_(); } ///< returns a iterator to the end
34303430

34313431
#if defined(__GNUC__) && !defined(__EDG__)
34323432
#pragma GCC diagnostic push
@@ -3438,11 +3438,11 @@ struct const_subarray<T, 1, ElementPtr, Layout> // NOLINT(fuchsia-multiple-inhe
34383438
#pragma GCC diagnostic pop
34393439
#endif
34403440

3441-
BOOST_MULTI_HD constexpr auto cbegin() const& -> const_iterator { return begin(); }
3442-
BOOST_MULTI_HD constexpr auto cend() const& -> const_iterator { return end(); }
3441+
BOOST_MULTI_HD constexpr auto cbegin() const& -> const_iterator { return begin(); } ///< returns an (explicitly const-)iterator to the beginning
3442+
BOOST_MULTI_HD constexpr auto cend() const& -> const_iterator { return end(); } ///< returns an (explicitly const-)iterator to the end
34433443

3444-
BOOST_MULTI_FRIEND_CONSTEXPR auto cbegin(const_subarray const& self) { return self.cbegin(); }
3445-
BOOST_MULTI_FRIEND_CONSTEXPR auto cend(const_subarray const& self) { return self.cend(); }
3444+
// BOOST_MULTI_FRIEND_CONSTEXPR auto cbegin(const_subarray const& self) { return self.cbegin(); }
3445+
// BOOST_MULTI_FRIEND_CONSTEXPR auto cend(const_subarray const& self) { return self.cend(); }
34463446

34473447
template<class It> constexpr auto assign(It first) && -> decltype(adl_copy_n(first, std::declval<size_type>(), std::declval<iterator>()), void()) {
34483448
return adl_copy_n(first, this->size(), std::move(*this).begin()), void();

0 commit comments

Comments
 (0)