RTOS2 Docs - minor fixes in examples
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2.txt
index 871b73d..9e3a188 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2.txt
@@ -423,7 +423,7 @@
The following example shows how to create an OS object using static memory.
\b Example:
-\code
+\code{.c}
/*----------------------------------------------------------------------------
* CMSIS-RTOS 'main' function template
*---------------------------------------------------------------------------*/
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Kernel.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Kernel.txt
index d413a36..f4d5d87 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Kernel.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Kernel.txt
@@ -21,7 +21,7 @@
-# Start the Kernel and begin thread switching by calling osKernelStart().
<b>Code Example</b>
-\code
+\code{.c}
int main (void) {
osKernelInitialize (); // initialize CMSIS-RTOS
@@ -64,7 +64,7 @@
Retrieve API and kernel version of the underlying RTOS kernel and a human readable identifier string of the kernel.
\b Example
-\code
+\code{.c}
void info (void) {
char infobuf[100];
osVersion_t osv;
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_MemPool.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_MemPool.txt
index 02771f1..0f8de54 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_MemPool.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_MemPool.txt
@@ -16,7 +16,7 @@
-------------------------
Follow these steps to create and use a memory pool:
-# Declare a data structure that combines a number of elements:
-\code
+\code{.c}
typedef struct {
uint32_t length;
uint32_t width;
@@ -25,16 +25,16 @@
} properties_t;
\endcode
-# Declare a memory pool of these objects as a block of memory:
-\code
+\code{.c}
osPoolDef (object_pool, 10, properties_t); // Declare memory pool
osPoolId (object_pool_id); // Memory pool ID
\endcode
-# Then, create the memory pool in a thread:
-\code
+\code{.c}
object_pool_id = osPoolCreate(osPool(object_pool));
\endcode
-# Allocate the pool within a thread and fill it with data:
-\code
+\code{.c}
properties_t *object_data;
*object_data = (properties_t *) osPoolAlloc(object_pool_id);
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Message.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Message.txt
index a054e92..57bcd00 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Message.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Message.txt
@@ -22,21 +22,21 @@
---------------------------
Follow these steps to create and use a message queue:
-# Setup the message queue:
-\code
+\code{.c}
osMessageQueueId_t MsgQ_Id; // Define a message queue ID
\endcode
-# Then, create the message queue in a thread:
-\code
+\code{.c}
MsgQId_Isr = osMessageQueueNew (16, sizeof(uint32_t), NULL); // Instance a message queue for 16 elements of uint32_t
\endcode
-# Fill the message queue with data:
-\code
+\code{.c}
uint32_t data = 512;
osMessageQueuePut(MsgQ_Id, data, 0, 0);
\endcode
-# From the receiving thread access the data using:
-\code
+\code{.c}
uint32_t msg;
osMessageQueueGet(MsgQ_Id, &msg, NULL, 0);
\endcode
@@ -67,7 +67,7 @@
\fn osStatus_t osMessageQueuePut (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t millisec)
\details
\b Example:
-\code
+\code{.c}
#include "cmsis_os2.h" // CMSIS RTOS header file
void *Thread_MsgQueue1 (void *argument); // thread function 1
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Mutex.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Mutex.txt
index 4cd0146..5dc5a41 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Mutex.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Mutex.txt
@@ -28,19 +28,19 @@
--------------------
To use mutexes, you need to follow these steps for creating and using them:
-# Declare the mutex container and initialize the mutex:
-\code
+\code{.c}
osMutexId (uart_mutex_id); // Mutex ID
\endcode
-# Create the mutex in a thread:
-\code
+\code{.c}
uart_mutex_id = osMutexNew(NULL);
\endcode
-# Acquire the mutex when peripheral access is required:
-\code
+\code{.c}
osMutexAcquire(uart_mutex_id, osWaitForever);
\endcode
-# When finished with the peripheral access, release the mutex:
-\code
+\code{.c}
osMutexRelease(uart_mutex_id);
\endcode
@@ -243,7 +243,7 @@
\details
String with a human readable name of the mutex object.
-\code
+\code{.c}
osMutexId_t mid_Thread_Mutex; // mutex id
const osMutexAttr_t Thread_Mutex_attr = {
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Sema.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Sema.txt
index a069252..f6c29a1 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Sema.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Sema.txt
@@ -24,23 +24,23 @@
--------------------
Follow these steps to create and use a semaphore:
-# Declare the semaphore container and initialize the semaphore:
-\code
+\code{.c}
osSemaphoreDef (my_semaphore); // Declare semaphore
osSemaphoreId (my_semaphore_id); // Semaphore ID
\endcode
-# Initialize the semaphore container with a number of tokens within a thread:
-\code
+\code{.c}
my_semaphore_id = osSemaphoreCreate(osSemaphore(my_semaphore), 4); // Create semaphore with 4 tokens
\endcode
\b Important: semaphore tokens can be created and destroyed as threads run. This means that can initialize a semaphore with
zero tokens and then use one thread to add/create tokens to the semaphore while a second thread removes them. In this way you
can distinguish between producer and consumer threads.
-# Acquire a token from the semaphore container:
-\code
+\code{.c}
osSemaphoreAcquire(my_semaphore_id, osWaitForever);
\endcode
-# When finished using the semaphore resource, send the token back to the semaphore container:
-\code
+\code{.c}
osSemaphoreRelease(my_semaphore_id);
\endcode
@@ -62,7 +62,7 @@
token. When all threads have exited the token number is back to n. Ths following example shows the code for one of the
threads that might access the resource:
-\code
+\code{.c}
osSemaphoreId_t multiplex_id;
void thread_n (void)
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Thread.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Thread.txt
index 80ef53e..a666ab7 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Thread.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Thread.txt
@@ -139,7 +139,7 @@
Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
\b Example:
-\code
+\code{.c}
void ThreadGetId_example (void) {
osThreadId id; // id for the currently running thread
@@ -176,7 +176,7 @@
Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
\b Example:
-\code
+\code{.c}
#include "cmsis_os2.h"
void Thread_1 (void const *arg) { // Thread function
@@ -213,7 +213,7 @@
Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
\b Example:
-\code
+\code{.c}
#include "cmsis_os2.h"
void Thread_1 (void const *arg) { // Thread function
@@ -243,7 +243,7 @@
Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
\b Example:
-\code
+\code{.c}
#include "cmsis_os2.h"
void Thread_1 (void const *arg) { // Thread function
@@ -306,7 +306,7 @@
\b Example:
\todo this example may not compile.... void *worker ???
-\code
+\code{.c}
#include "cmsis_os2.h"
void *worker(void *arg)
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_ThreadFlags.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_ThreadFlags.txt
index 4ea3bcf..9715ead 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_ThreadFlags.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_ThreadFlags.txt
@@ -17,7 +17,7 @@
The threads waiting for the flag set will be notified to resume from BLOCKED state.
<b>Code Example</b>
-\code
+\code{.c}
void *Thread (void *arg);
static void EX_Signal_1 (void) {
@@ -58,7 +58,7 @@
<b>Code Example</b>
-\code
+\code{.c}
#include "cmsis_os2.h"
:
void *Thread (void* arg) {
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Timer.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Timer.txt
index 1fa831e..c64a7cc 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Timer.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Timer.txt
@@ -25,11 +25,11 @@
--------------------
The following steps are required to use a timer:
-# Define the timers:
-\code
+\code{.c}
osTimerId one_shot_id, periodic_id;
\endcode
-# Instantiate and start the timers:
-\code
+\code{.c}
one_shot_id = osTimerNew((os_timer_func_t)&one_shot_Callback, osTimerOnce, (void *)0); // creates a one-shot timer;
// (void*)0 is passed as an argument
// to the callback function
diff --git a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Wait.txt b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Wait.txt
index 98e1f69..5182aab 100644
--- a/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Wait.txt
+++ b/CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Wait.txt
@@ -30,7 +30,7 @@
\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
<b>Code Example</b>
-\code
+\code{.c}
#include "cmsis_os2.h"
void *Thread_1 (void *arg) { // Thread function
@@ -63,7 +63,7 @@
\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
<b>Code Example</b>
-\code
+\code{.c}
#include "cmsis_os2.h"
void *Thread_1 (void *arg) { // Thread function