Skip to content

Commit 03d308d

Browse files
committed
Span: Add related non member function to class documentation.
1 parent a0786ad commit 03d308d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

platform/Span.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -780,6 +780,8 @@ struct Span<ElementType, SPAN_DYNAMIC_EXTENT> {
780780
*
781781
* @return True if Spans in input have the same size and the same content and
782782
* false otherwise.
783+
*
784+
* @relates Span
783785
*/
784786
template<typename T, typename U, ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
785787
bool operator==(const Span<T, LhsExtent> &lhs, const Span<U, RhsExtent> &rhs)
@@ -833,6 +835,8 @@ bool operator==(T (&lhs)[LhsExtent], const Span<T, RhsExtent> &rhs)
833835
*
834836
* @return True if arrays in input do not have the same size or the same content
835837
* and false otherwise.
838+
*
839+
* @relates Span
836840
*/
837841
template<typename T, typename U, ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
838842
bool operator!=(const Span<T, LhsExtent> &lhs, const Span<U, RhsExtent> &rhs)
@@ -882,6 +886,8 @@ bool operator!=(T (&lhs)[LhsExtent], const Span<T, RhsExtent> &rhs)
882886
*
883887
* @note This helper avoids the typing of template parameter when Span is
884888
* created 'inline'.
889+
*
890+
* @relates Span
885891
*/
886892
template<typename T, size_t Size>
887893
Span<T, Size> make_Span(T (&elements)[Size])
@@ -920,6 +926,8 @@ Span<T, Extent> make_Span(T *elements)
920926
*
921927
* @note This helper avoids the typing of template parameter when Span is
922928
* created 'inline'.
929+
*
930+
* @relates Span
923931
*/
924932
template<typename T>
925933
Span<T> make_Span(T *array_ptr, ptrdiff_t array_size)
@@ -957,6 +965,8 @@ Span<const T, Extent> make_const_Span(const T (&elements)[Extent])
957965
*
958966
* @note This helper avoids the typing of template parameter when Span is
959967
* created 'inline'.
968+
*
969+
* @relates Span
960970
*/
961971
template<size_t Extent, typename T>
962972
Span<const T, Extent> make_const_Span(const T *elements)
@@ -977,6 +987,8 @@ Span<const T, Extent> make_const_Span(const T *elements)
977987
*
978988
* @note This helper avoids the typing of template parameter when Span is
979989
* created 'inline'.
990+
*
991+
* @relates Span
980992
*/
981993
template<typename T>
982994
Span<const T> make_const_Span(T *array_ptr, size_t array_size)

0 commit comments

Comments
 (0)