Jordan Brack / SmartWheelsPublic

SmartWheels self-driving race car. Designed for NXP Cup. Uses FRDM-KL25Z, area-scan camera, and simple image processing to detect and navigate any NXP spec track.

Dependencies:   TSI USBDevice mbed-dev

Fork of SmartWheels by haofan Zheng

Diff: GlobalVariable.h

Revision:
94:32712e603a5f
Parent:
87:15fcf7891bf9
--- a/GlobalVariable.h	Wed Apr 19 18:34:12 2017 +0000
+++ b/GlobalVariable.h	Wed Apr 19 18:57:23 2017 +0000
@@ -1,8 +1,15 @@
+/**
+ * @file GlobalVariable.h
+ * @brief The header file for the global variable. Some object (ex. SPI port) can have only one instance, but it is used in many different place. Thus, these variables will be declare in this header file.
+ * @author Jordan Brack <jabrack@mix.wvu.edu>, Haofan Zheng <hazheng@mix.wvu.edu>
+ * 
+ */
+#pragma once
 #ifndef GLOBAL_VARIABLE_H
 #define GLOBAL_VARIABLE_H
 
 #include <mbed.h>
 
-extern SPI g_spi_port;
+extern SPI g_spi_port; /*!< @brief The SPI port connection. NOTE: This is a declaration of a extern variable. It is actually defined and initialized in main.cpp file. */
 
 #endif //GLOBAL_VARIABLE_H
\ No newline at end of file