documentation of code... ongoing

bsl/csl/stm32f042/Device/hardwareDescription.h

@@ -69,7 +69,7 @@ typedef enum
 	pinF1 =  0x20 | 1	/*!< Port: F Pin: 1  ->  Port F Mask | Pin Mask */
 }pinNo_t;    
 
-/**List of all possible port base addresses. This is used for the funcionality of of pin.h*/
+/*!List of all possible port base addresses. This is used for the funcionality of of pin.h*/
 static const  uint32_t portBase_Addr_List[MAX_N_PORTS_COUNT] = {
 	GPIOA_BASE,	//!< Base address Port A 
 	GPIOB_BASE, //!< Base address Port B
@@ -78,7 +78,8 @@ static const  uint32_t portBase_Addr_List[MAX_N_PORTS_COUNT] = {
 
 /*! This is a bitmap list of all possible alternative functions for each pin.
  *	1means that there is an alternative function available and 0 for none. Tis is used
- *	for the functionality in pin.h*/             
+ *	for the functionality in pin.h
+ *	*/             
 static const uint8_t altFunc_List[MAX_N_PORTS_COUNT][MAX_PORT_PINS_COUNT] = {
 	{	// PORT A
 		0b01110000, //PA0 
@@ -137,7 +138,7 @@ static const uint8_t altFunc_List[MAX_N_PORTS_COUNT][MAX_PORT_PINS_COUNT] = {
 };
 
 
-/** 
+/*!
  * Enum for awailable timer DS Page: 12 (block diagaram) The order of the enums is very important
  * and should not be changed as it is used ofr table indexing 
  * */
@@ -150,7 +151,7 @@ typedef enum {
 	timer_17	/*!< General purpose 16-bit timer RM Page: 480 */
 } timerNo_t;
 
-/** 
+/*! 
  * Enum for awailable clok sources RM Page: 95 
  * */
 typedef enum { 
@@ -160,19 +161,19 @@ typedef enum {
 	LSE		/*!< Low speed External */
 }clkSources_t;
 
-/**
+/*!
  *	Timer base addresslist of all available timers
  * */
 static const uint32_t timerBase_Addr_List[MAX_TIMER_CHANNEL_COUNT] = {
-	TIM1_BASE, 
+	TIM1_BASE,	/*!< Timer 1 Base Address */ 
-	TIM2_BASE, 
+	TIM2_BASE,	/*!< Timer 2 Base Address */
-	TIM3_BASE, 
+	TIM3_BASE,	/*!< Timer 3 Base Address */
-	TIM14_BASE, 
+	TIM14_BASE, /*!< Timer 14 Base Address */
-	TIM16_BASE, 
+	TIM16_BASE, /*!< Timer 16 Base Address */
-	TIM17_BASE
+	TIM17_BASE	/*!< Timer 17 Base Address */
 };
 
-/**
+/*!
  *	RCC clock enabcke bit position for the given register
  * */
 static const uint8_t timerBus_En_bitPos[MAX_TIMER_CHANNEL_COUNT] = {