/******************************************************************************* * 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 - 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 is the source file for TODO: WHAT DO I DO? */ /****************************************************************************** * Includes *******************************************************************************/ #include <stdint.h> /* For portable types */ #include "${moduleInclude}.h" /* For this modules declarations */ /****************************************************************************** * Module Preprocessor Constants *******************************************************************************/ /** * Doxygen tag for documenting variables and constants */ #define CONSTANT 5 /****************************************************************************** * Module Preprocessor Macros *******************************************************************************/ /****************************************************************************** * Module Typedefs *******************************************************************************/ /****************************************************************************** * Module Variable Definitions *******************************************************************************/ /****************************************************************************** * Function Prototypes *******************************************************************************/ /****************************************************************************** * Function Definitions *******************************************************************************/ // TODO: UPDATE AND COPY THESE FOR EACH NON_TRIVIAL FUNCTION /****************************************************************************** * Function : ${module}_Init() *//** * b Description: * * This function is used to initialize the ${module} based on the configuration * table defined in dio_cfg module. * * PRE-CONDITION: Configuration table needs to populated (sizeof > 0) * * POST-CONDITION: A constant pointer to the first member of the configuration * table will be returned. * * @return A pointer to the configuration table. * * b Example Example: * @code * const Dio_ConfigType *DioConfig = Dio_GetConfig(); * * Dio_Init(DioConfig); * @endcode * * @see ${module}_Init * *******************************************************************************/ void ${module}( void ) { } /*************** END OF FUNCTIONS ***************************************************************************/
Contact Us Today! [email protected]