mirror of
https://github.com/pound-emu/ballistic.git
synced 2026-01-31 01:15:21 +01:00
docs: add template files
These template files come from the Barr C style guide. Signed-off-by: Ronald Caesar <github43132@proton.me>
This commit is contained in:
23
docs/header_template.h
Normal file
23
docs/header_template.h
Normal file
@@ -0,0 +1,23 @@
|
||||
/** @file module.h
|
||||
*
|
||||
* @brief A description of the module’s purpose.
|
||||
*
|
||||
* @par
|
||||
*/
|
||||
|
||||
#ifndef MODULE_H
|
||||
#define MODULE_H
|
||||
|
||||
/*!
|
||||
* @brief Identify the larger of two 8-bit integers.
|
||||
*
|
||||
* @param[in] num1 The first number to be compared.
|
||||
* @param[in] num2 The second number to be compared.
|
||||
*
|
||||
* @return The value of the larger number.
|
||||
*/
|
||||
int8_t max8(int8_t num1, int8_t num2);
|
||||
|
||||
#endif /* MODULE_H */
|
||||
|
||||
/*** end of file ***/
|
||||
27
docs/source_template.c
Normal file
27
docs/source_template.c
Normal file
@@ -0,0 +1,27 @@
|
||||
/** @file module.c
|
||||
*
|
||||
* @brief A description of the module’s purpose.
|
||||
*
|
||||
* @par
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include “module.h”
|
||||
|
||||
/*!
|
||||
* @brief Identify the larger of two 8-bit integers.
|
||||
*
|
||||
* @param[in] num1 The first number to be compared.
|
||||
* @param[in] num2 The second number to be compared.
|
||||
*
|
||||
* @return The value of the larger number.
|
||||
*/
|
||||
int8_t
|
||||
max8 (int8_t num1, int8_t num2)
|
||||
{
|
||||
return ((num1 > num2) ? num1 : num2);
|
||||
}
|
||||
|
||||
/*** end of file ***/
|
||||
Reference in New Issue
Block a user