header.h File Reference

#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Classes
struct	Foo
	Class Foo brief description. More...

Functions
uint8_t const *	free_fun (uint32_t x)
	Free function brief description.
void	Foo_ctor (Foo *const me, uint32_t const x)
	Constructor of class Foo brief description.
bool	Foo_verify_ (Foo const *const me)
	Verify operation to check the class invariant.
void	Foo_update_ (Foo *const me)
	Update operation to update the class invariant.

Variables
Foo const	Foo_inst
	Foo instance brief description (singleton).

Function Documentation

free_fun()

uint8_t const * free_fun

(

uint32_t

x

)

Free function brief description.

Details
Free function longer description.

Parameters

[in]

x

- the parameter x

Returns

pointer to a static array

Backward Traceability

• SRS_EXA_FF_00: My project shall provide a free function foo().

Forward Traceability

• TUN_PRJ_free_fun_00: zero input test
• TUN_PRJ_free_fun_01: non-zero input test

Definition at line 3 of file source.c.

Foo_ctor()

void Foo_ctor	(	Foo *const	me,
		uint32_t const	x )

Constructor of class Foo brief description.

Details
Constructor of class Foo longer description.

Parameters

[in]	me	- the instance pointer (OOP in C)
[in]	x	- the initial value for me->x

Backward Traceability

• SRS_EXA_Foo_02: Class Foo shall provide a constructor.
• Foo: Class Foo brief description

Forward Traceability

• TUN_PRJ_Foo_ctor_01: constructor test

Definition at line 12 of file source.c.

Foo_verify_()

bool Foo_verify_

(

Foo const *const

me

)

Verify operation to check the class invariant.

Details
Operation verify_() of class Foo longer description.

Parameters

[in]

me

- the instance pointer (OOP in C)

Returns

'true' when the Foo instance verification succeeds, 'false' otherwise.

Backward Traceability

• SRS_EXA_Foo_03: Class Foo shall provide a verify operation.
• Foo: Class Foo brief description

Forward Traceability

• Foo::x_dis: Duplicate Inverse Storage for attribute Foo::x
• TUN_PRJ_Foo_verify_00: verify positive test
• TUN_PRJ_Foo_verify_01: verify negative test

Definition at line 21 of file source.c.

Foo_update_()

void Foo_update_

(

Foo *const

me

)

Update operation to update the class invariant.

Details
Constructor of class Foo longer description.

Parameters

[in]

me

- the instance pointer (OOP in C)

Backward Traceability

• SRS_EXA_Foo_04: Class Foo shall provide an update operation.
• Foo: Class Foo brief description

Forward Traceability

Definition at line 17 of file source.c.

Variable Documentation

Foo_inst

Foo const Foo_inst

extern

Foo instance brief description (singleton).

Details
Foo instance longer description.

Backward Traceability

• SRS_EXA_Foo_05: Class Foo shall be a singleton.
• Foo: Class Foo brief description

Forward Traceability