templatemodule.c File Reference

template module More...

Functions
CLI bindings
int_fast8_t	templatemodule_examplefunction00_cli ()
int_fast8_t	templatemodule_examplefunction01_cli ()
Module initialization
int_fast8_t	init_templatemodule ()
	Initialize module. More...
TEMPLATEMODULE - 1. FIRST GROUP OF FUNCTIONS
int	templatemodule_examplefunc00 (int mode)
	one-line description of function More can be included here if needed More...
TEMPLATEMODULE - 2.1. SECOND GROUP OF FUNCTIONS - SUBGROUP1
int	templatemodule_examplefunc01 (const char *namein, float val1, int n1, float *restrict farray)

Detailed Description

template module

Follow this template to write your C code The template includes examples of frequently used coding practices and doxygen-based documentation

Source code includes notes (comments):

• CODING STANDARD NOTE : note about coding practices and standards
• DOCUMENTATION NOTE : how to document code

Other files of interest

Each module should include :

• souce code (.c file)
• header file (.h file)

Change log

• 20180120 Guyon Added mode documentation
• 20170813 Guyon Added some documentation

Author

O. Guyon

Bug:

No known bugs.

Function Documentation

int_fast8_t init_templatemodule

(

)

Initialize module.

int templatemodule_examplefunc00

(

int

mode

)

one-line description of function More can be included here if needed

Purpose

This function does absolutely nothing useful

Arguments

Parameters

[in]

mode

INT mode sets up what function does does nothing also does nothing

int_fast8_t templatemodule_examplefunction00_cli

(

)

int_fast8_t templatemodule_examplefunction01_cli

(

)