Refactored the module header
+ Updated header comments for doxygen usage. + Added in basic usage headers. + Added in Cpp extern lines for Cpp/C usage.
This commit is contained in:
parent
1ebd68346e
commit
ecda1c8095
1 changed files with 22 additions and 5 deletions
|
|
@ -1,14 +1,31 @@
|
|||
/*
|
||||
* Author: username
|
||||
* Date: todays_date
|
||||
* filename: module_name.h
|
||||
* description: module_purpose
|
||||
/**
|
||||
* @brief Module description
|
||||
* @details This file is an <Purpose here>
|
||||
* @author Jake G
|
||||
* @date todays_date
|
||||
* @copyright None
|
||||
* @file module_name.h
|
||||
*/
|
||||
|
||||
//#pragma once
|
||||
#ifndef module_name
|
||||
#define module_name
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C"
|
||||
{
|
||||
#endif
|
||||
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
|
||||
int add_two(int a);
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif // __cplusplus
|
||||
|
||||
#endif //module_name
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue