/**************************************************************************** * Title : ${module} * Author : ${author} * Origin Date : ${date} * Notes : None * * THIS SOFTWARE IS PROVIDED BY ${company} "AS IS" AND ANY EXPRESSED * 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 ${company} OR ITS 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. * *****************************************************************************/ /**************************************************************************** * Doxygen C Template * Copyright (c) 2013 - Present -- Jacob Beningo - All Rights Reserved * * Feel free to use this Doxygen Code Template at your own risk for your own * purposes. The latest license and updates for this Doxygen C template can be * found at www.beningo.com or by contacting Jacob at [email protected]. * * For updates, free software, training and to stay up to date on the latest * embedded software techniques sign-up for Jacobs newsletter at * https://beningo.com/814-2/ * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Template. * *****************************************************************************/ /** @file ${module} * @brief This module TODO: WHAT DO I DO? * * This is the header file for the definition TODO: MORE ABOUT ME! */ #ifndef ${fileMacro}_H_ #define ${fileMacro}_H_ /****************************************************************************** * Includes *******************************************************************************/ #include <stdint.h> #include <stdbool.h> /****************************************************************************** * Module Preprocessor Constants *******************************************************************************/ /** * Doxygen tag for documenting variables and constants */ #define CONSTANT 5 /****************************************************************************** * Module Preprocessor Macros *******************************************************************************/ /****************************************************************************** * Module Typedefs *******************************************************************************/ /** * This enumeration is a list of test types */ typedef enum { TEST_TEST1, /**< Test Type 1 */ TEST_TEST2, /**< Test Type 2 */ }Test_t; /****************************************************************************** * Module Variable Definitions *******************************************************************************/ /****************************************************************************** * Function Prototypes *******************************************************************************/ #ifdef __cplusplus extern "C"{ #endif void ${module}_Init(void); #ifdef __cplusplus } // extern "C" #endif #endif /*${fileMacro}*/ /*** End of File **************************************************************/
Contact Us Today! [email protected]