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

stats - Added doxygen documentation to stats functions

pull/3141/head
Christopher Haster 2016-10-28 11:20:12 -05:00
parent 9b630b3e0d
commit e90fff3a60
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
platform/mbed_stats.h
View File

@ -35,7 +35,9 @@ typedef struct {
} mbed_stats_heap_t;
/**
* Fill the passed in structure with heap stats.
* Fill the passed in heap stat structure with heap stats.
*
* @param stats A pointer to the mbed_stats_heap_t structure to fill
*/
void mbed_stats_heap_get(mbed_stats_heap_t *stats);
@ -48,12 +50,19 @@ typedef struct {
/**
* Fill the passed in structure with stack stats.
*
* @param stats A pointer to the mbed_stats_stack_t structure to fill
*/
void mbed_stats_stack_get(mbed_stats_stack_t *stats);
/**
* Fill the passed array of stat structures with the stack stats
* for each available stack.
*
* @param stats A pointer to an array of mbed_stats_stack_t structures to fill
* @param count The number of mbed_stats_stack_t structures in the provided array
* @return The number of mbed_stats_stack_t structures that have been filled,
* this is equal to the number of stacks on the system.
*/
size_t mbed_stats_stack_get_each(mbed_stats_stack_t *stats, size_t count);