Merge branch 'develop' of https://github.com/ARM-software/CMSIS-FreeRTOS into develop

Author: VladimirUmek

DoxyGen/General/general.dxy

@@ -749,7 +749,10 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = .
+INPUT                  = . \
+                         ../../CMSIS/RTOS2/FreeRTOS/Include/freertos_evr.h \
+                         ./src/freertos_evr.txt
+                         
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -758,7 +761,7 @@ INPUT                  = .
 # possible encodings.
 # The default value is: UTF-8.
 
-INPUT_ENCODING         = UTF-8
+INPUT_ENCODING         = ISO-8859-1
 
 # If the value of the INPUT tag contains directories, you can use the
 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and

DoxyGen/General/src/cmsis_freertos.txt

@@ -373,4 +373,16 @@ Memory Pool functions are not implemented and will always return with error.
    - \b osMessageQueueNew: supported
    - \b osMessageQueuePut: ignores message priority.
    - \b osMessageQueueReset: supported   
-*/
+*/
+
+/* ======================================================================================================================== */
+// Group creation for Reference 
+/** 
+\addtogroup freertos_specific CMSIS-FreeRTOS Specifics
+\brief This section describes CMSIS-FreeRTOS specifics.
+\details
+CMSIS-FreeRTOS interfaces to the
+<a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank"><b>Event Recorder</b></a> 
+to provide event information which helps you to understand and analyze the operation. Refer to \ref freertos_evr for more
+information.
+*/

DoxyGen/General/src/freertos_evr.txt

@@ -0,0 +1,21 @@
+/** 
+\defgroup freertos_evr Event functions
+\ingroup freertos_specific 
+\brief FreeRTOS Event Recorder functions
+\details
+CMSIS-FreeRTOS interfaces to the
+<a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank"><b>Event Recorder</b></a> 
+to provide event information which helps you to understand and analyze the operation.
+
+To use the Event Recorder together with CMSIS-FreeRTOS, it is required to create an image that generates event information.
+The steps are:
+  - <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/UseDebugViews.html#Add_Event_Recorder" target="_blank"><b>Add Event Recorder</b></a>: Select in the RTE management dialog the software component <b>Compiler:Event Recorder</b>.
+  - <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/UseDebugViews.html#Debug_Variants" target="_blank"><b>Select Debug Variant</b></a>: Select in the RTE management dialog the \b Source variant for the software component <b>CMSIS:RTOS2 (API):Keil RTX5</b>.
+  - <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/group__EventRecorder__Setup.htm" target="_blank"><b>Add Initialization Code</b></a>: Call the function <b>EventRecorderInitialize</b> in your application code.
+  - Build the application code and download it to the debug hardware.
+  
+Once the target application generates event information, it can be viewed in the �Vision debugger using the \b Event
+ \b Recorder.
+
+@{
+*/