Merge pull request #4790 from bulislaw/mem_stats

Improve documentation for memory stat ops

Author: theotherjimmy

platform/mbed_stats.h

@@ -42,22 +42,22 @@ typedef struct {
 void mbed_stats_heap_get(mbed_stats_heap_t *stats);
 
 typedef struct {
-    uint32_t thread_id;         /**< Identifier for thread that owns the stack. */
-    uint32_t max_size;          /**< Sum of the maximum number of bytes used in each stack. */
-    uint32_t reserved_size;     /**< Current number of bytes allocated for all stacks. */
-    uint32_t stack_cnt;         /**< Number of stacks currently allocated. */
+    uint32_t thread_id;         /**< Identifier for thread that owns the stack or 0 if multiple threads. */
+    uint32_t max_size;          /**< Maximum number of bytes used on the stack. */
+    uint32_t reserved_size;     /**< Current number of bytes allocated for the stack. */
+    uint32_t stack_cnt;         /**< Number of stacks stats accumulated in the structure. */
 } mbed_stats_stack_t;
 
 /**
- *  Fill the passed in structure with stack stats.
+ *  Fill the passed in structure with stack stats accumulated for all threads. The thread_id will be 0
+ *  and stack_cnt will represent number of threads.
  *
  *  @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.
+ *  Fill the passed array of stat structures with the stack stats for each available thread.
  *
  *  @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