ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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
Vincent Coubard 2018-10-23 11:38:01 +01:00
parent ba23fef90b
commit a0786adbc4
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
platform/Span.h
View File

@ -47,12 +47,18 @@ public:
} }
#if defined(DOXYGEN_ONLY)
/** /**
* Special value for the Extent parameter of Span. * 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 * If the type uses this value, then the size of the array is stored in the object
* at runtime. * at runtime.
*
* @relates Span
*/ */
const ptrdiff_t SPAN_DYNAMIC_EXTENT = -1;
#else
#define SPAN_DYNAMIC_EXTENT -1 #define SPAN_DYNAMIC_EXTENT -1
#endif
/** /**
* Nonowning view to a sequence of contiguous elements. * Nonowning view to a sequence of contiguous elements.