templatemodule.c File Reference

template module More...

#include <math.h>
#include <stdio.h>
#include <strangefile.h>
#include <fitsio.h>
#include "CLIcore.h"
#include "00CORE/00CORE.h"
#include "COREMOD_memory/COREMOD_memory.h"
#include "COREMOD_iofits/COREMOD_iofits.h"
#include "COREMOD_tools/COREMOD_tools.h"
#include "COREMOD_arith/COREMOD_arith.h"
#include "templatemodule/templatemodule.h"

Include dependency graph for templatemodule.c:

Macros
#define	TWOPLUSTWO   4
	CODING STANDARD NOTE: code indented by : bash -c "astyle --indent-classes -Y". More...
#define	NAME_STRING_MAXSIZE   100
#define	FNAME_STRING_MAXSIZE   200
#define	COMMAND_STRING_MAXSIZE   200
#define	ABS(x)   (((x) < 0) ? -(x) : (x))
#define	EXAMPLEMODULE_MAX(a, b)   ((a < b) ? (b) : (a))

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.

Macro Definition Documentation

ABS

#define ABS

(

x

)

(((x) < 0) ? -(x) : (x))

COMMAND_STRING_MAXSIZE

#define COMMAND_STRING_MAXSIZE   200

EXAMPLEMODULE_MAX

#define EXAMPLEMODULE_MAX	(		a,
			b
	)		((a < b) ? (b) : (a))

FNAME_STRING_MAXSIZE

#define FNAME_STRING_MAXSIZE   200

NAME_STRING_MAXSIZE

#define NAME_STRING_MAXSIZE   100

TWOPLUSTWO

#define TWOPLUSTWO   4

CODING STANDARD NOTE: code indented by : bash -c "astyle --indent-classes -Y".

CODING STANDARD NOTE: document any unusual head file include

Function Documentation

init_templatemodule()

int_fast8_t init_templatemodule

(

)

Initialize module.

templatemodule_examplefunc00()

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

mode sets up what function does does nothing also does nothing

templatemodule_examplefunction00_cli()

int_fast8_t templatemodule_examplefunction00_cli

(

)

templatemodule_examplefunction01_cli()

int_fast8_t templatemodule_examplefunction01_cli

(

)