Diff: Driver/main.h

Revision:

15:2860c960d2ff

Parent:

14:05245fe1a7a0

Child:

22:5b77cf59d630

--- a/Driver/main.h	Tue Jul 24 02:51:20 2018 +0000
+++ b/Driver/main.h	Wed Jul 25 17:38:48 2018 +0000
@@ -13,14 +13,45 @@
 /*******************************************************************************
   * @File Name    : main.h
   * @Author       : Fahad Mirza
-  * @Created      : 22 January, 2018
-  * @Modified     : 04 April, 2018
+  * @Modified     : 04 July, 2018
   * @Description  : Header file for main.c
-********************************************************************************/
-
+  ******************************************************************************
+  * @attention
+  *
+  * <h2><center>&copy; COPYRIGHT(c) 2017 Haxiot</center></h2>
+  *
+  * Redistribution and use in source and binary forms, with or without modification,
+  * are permitted provided that the following conditions are met:
+  *   1. Redistributions of source code must retain the above copyright notice,
+  *      this list of conditions and the following disclaimer.
+  *   2. Redistributions in binary form must reproduce the above copyright notice,
+  *      this list of conditions and the following disclaimer in the documentation
+  *      and/or other materials provided with the distribution.
+  *   3. Neither the name of Haxiot nor the names of its contributors
+  *      may be used to endorse or promote products derived from this software
+  *      without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  *
+  ******************************************************************************
+  */
+  
 #ifndef MAIN_H_
 #define MAIN_H_
 
+#ifdef __cplusplus
+ extern "C" {
+#endif 
+
 #include "hw.h"
 #include "debug.h"
 #include "delay.h"
@@ -44,7 +75,7 @@
 
 
 /******************************************************************************
-  * @brief :  System Clock Configuration
+  * @Brief :  System Clock Configuration
   * The system Clock is configured as follow :
   *      System Clock source            = PLL (HSI)
   *      SYSCLK(Hz)                     = 32000000
@@ -56,8 +87,8 @@
   *      PLLMUL                         = 6
   *      PLLDIV                         = 3
   *      Flash Latency(WS)              = 1
-  * @retval: None
-  * @note  : This function enables all the clock necessary for the demo
+  * @Return: None
+  * @Note  : This function enables all the clock necessary for the demo
   *          including UARTs
 ******************************************************************************/
 void SystemClock_Config(void)
@@ -102,8 +133,8 @@
 
 /******************************************************************************
  * @Brief : Set all pin as analog
- * @Param : none
- * @return: none
+ * @Param : None
+ * @Return: None
 ******************************************************************************/
 void HW_GpioInit(void)
 {
@@ -145,7 +176,7 @@
 /******************************************************************************
   * @Brief : This function initializes the hardware
   * @Param : None
-  * @Retval: None
+  * @Return: None
 ******************************************************************************/
 void HW_Init(void)
 {
@@ -173,7 +204,7 @@
 /******************************************************************************
   * @Brief : Initializes the MSP.
   * @Param : None
-  * @retval: None
+  * @Return: None
 ******************************************************************************/
 void HAL_MspInit(void)
 {
@@ -209,7 +240,7 @@
    *          where the assert_param error has occurred.
    * @Param : file: pointer to the source file name
    *          line: assert_param error line source number
-   * @Retval: None
+   * @Return: None
 ******************************************************************************/
 void assert_failed(uint8_t* file, uint32_t line)
 {
@@ -219,5 +250,9 @@
 
 #endif
 
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
 #endif /* MAIN_H_ */