Skip to content

Commit a0786ad

Browse files
committed
Span: Improve documentation
Makes doxygen reference to SPAN_DYNAMIC_EXTENT by name instead of the macro expansion -1. Add reference to the macro in the class documentation.
1 parent ba23fef commit a0786ad

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

platform/Span.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,18 @@ class is_convertible
4747

4848
}
4949

50+
#if defined(DOXYGEN_ONLY)
5051
/**
5152
* Special value for the Extent parameter of Span.
5253
* If the type uses this value, then the size of the array is stored in the object
5354
* at runtime.
55+
*
56+
* @relates Span
5457
*/
58+
const ptrdiff_t SPAN_DYNAMIC_EXTENT = -1;
59+
#else
5560
#define SPAN_DYNAMIC_EXTENT -1
61+
#endif
5662

5763
/**
5864
* Nonowning view to a sequence of contiguous elements.

0 commit comments

Comments
 (0)