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
|
* @brief Module description
|
||||||
* Date: todays_date
|
* @details This file is an <Purpose here>
|
||||||
* filename: module_name.h
|
* @author Jake G
|
||||||
* description: module_purpose
|
* @date todays_date
|
||||||
|
* @copyright None
|
||||||
|
* @file module_name.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
//#pragma once
|
||||||
#ifndef module_name
|
#ifndef module_name
|
||||||
#define module_name
|
#define module_name
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C"
|
||||||
|
{
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#include <stdint.h>
|
||||||
|
#include <stdbool.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
|
||||||
int add_two(int a);
|
int add_two(int a);
|
||||||
|
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif // __cplusplus
|
||||||
|
|
||||||
#endif //module_name
|
#endif //module_name
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue