C Header TemplateΒΆ

/**
 * File Name: 
 * Description:
 */

// Header Guard
#ifndef MY_HEADER_GUARD_H_
#define MY_HEADER_GUARD_H_

/***************************************************************************************************/
/* Include Files */
/***************************************************************************************************/

// C Interface
#ifdef __cplusplus
extern "C" {
#endif
/***************************************************************************************************/
/* C Public Data Types */
/***************************************************************************************************/

/***************************************************************************************************/
/* C Public Constants */
/***************************************************************************************************/
/*This is an example description for constants and variables. Delete this if it is unused here and copy and paste it to where it is needed. */
/**
 * @brief This is a brief description
 */

/***************************************************************************************************/
/* C Public Variables(extern) */
/***************************************************************************************************/

/***************************************************************************************************/
/* C Public Function Prototypes */
/***************************************************************************************************/
/*This is an example description for function prototypes. Delete this if it is unused here and copy and paste it to where it is needed. */
/**
 * @brief This is a brief description
 * @param Input_Param_Name - Description of input parameter
 * @ret Description of return value
 */


#ifdef __cplusplus
}
#endif //End C Interface

// C++ Interface
#ifdef __cplusplus

/***************************************************************************************************/
/* Public Function Prototypes */
/***************************************************************************************************/

/***************************************************************************************************/
/* Class Definitions */
/***************************************************************************************************/

class MY_CLASS
{
public:
/***************************************************************************************************/
/* Constructors */
/***************************************************************************************************/

/***************************************************************************************************/
/* Public Data Types */
/***************************************************************************************************/

/***************************************************************************************************/
/* Public Constants(static constexpr) */
/***************************************************************************************************/

/***************************************************************************************************/
/* Public Variables */
/***************************************************************************************************/

/***************************************************************************************************/
/* Public Function Prototypes */
/***************************************************************************************************/

private:
/***************************************************************************************************/
/* Private Data Types */
/***************************************************************************************************/

/***************************************************************************************************/
/* Private Constants(static constexpr) */
/***************************************************************************************************/

/***************************************************************************************************/
/* Private Variables */
/***************************************************************************************************/

/***************************************************************************************************/
/* Private Function Prototypes */
/***************************************************************************************************/
};

#endif //End C++ Interface

#endif //End Header Guard