Modified uxTaskGetStackHighWaterMark() to take a parameter for the task to be checked...

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@230 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

diff --git a/Source/include/task.h b/Source/include/task.h
index 98f1cb78f676e3ce04fecb072652388bc85daeee..169f8393bcc5f017427b031e673733d4a8464b4a 100644 (file)
--- a/Source/include/task.h
+++ b/Source/include/task.h
@@ -868,17 +868,23 @@ unsigned portLONG ulTaskEndTrace( void );
 \r
 /**\r
  * task.h\r
- * <PRE>unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( void );</PRE>\r
+ * <PRE>unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask );</PRE>\r
  *\r
  * INCLUDE_uxTaskGetStackHighWaterMark must be set to 1 in FreeRTOSConfig.h for\r
  * this function to be available.\r
  *\r
- * Returns the high water mark for the stack of the calling task.  That is,\r
+ * Returns the high water mark of the stack associated with xTask.  That is,\r
  * the minimum free stack space there has been (in bytes) since the task\r
- * started.  The small the returned number the closer the task has come\r
+ * started.  The smaller the returned number the closer the task has come\r
  * to overflowing its stack.\r
+ *\r
+ * @param xTask Handle of the task associated with the stack to be checked.\r
+ * Set xTask to NULL to check the stack of the calling task.\r
+ *\r
+ * @return The smallest amount of free stack space there has been (in bytes)\r
+ * since the task referenced by xTask was created.\r
  */\r
-unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( void );\r
+unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask );\r
 \r
 /*-----------------------------------------------------------\r
  * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES\r