mirror of https://github.com/ARMmbed/mbed-os.git
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.pull/8504/head
parent
ba23fef90b
commit
a0786adbc4
|
@ -47,12 +47,18 @@ public:
|
|||
|
||||
}
|
||||
|
||||
#if defined(DOXYGEN_ONLY)
|
||||
/**
|
||||
* Special value for the Extent parameter of Span.
|
||||
* If the type uses this value, then the size of the array is stored in the object
|
||||
* at runtime.
|
||||
*
|
||||
* @relates Span
|
||||
*/
|
||||
const ptrdiff_t SPAN_DYNAMIC_EXTENT = -1;
|
||||
#else
|
||||
#define SPAN_DYNAMIC_EXTENT -1
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Nonowning view to a sequence of contiguous elements.
|
||||
|
|
Loading…
Reference in New Issue