My Project
Loading...
Searching...
No Matches
Typedefs | Enumerations | Functions
templateForC.h File Reference

This is our template for C headers. More...

Go to the source code of this file.

Typedefs

typedef int name
 New type name for int. More...
 

Enumerations

enum  myEnum { EVal1 , EVal2 }
 My enum. More...
 

Functions

int F1 (int a1, int &r1)
 F1. More...
 

Detailed Description

This is our template for C headers.

ABSTRACT: Some more description here.

Author
Oleksandr Motsak

Definition in file templateForC.h.

Typedef Documentation

◆ name

typedef int name

New type name for int.

Definition at line 21 of file templateForC.h.

Enumeration Type Documentation

◆ myEnum

enum myEnum

My enum.

Or yours, if you want!

Enumerator
EVal1 

Enum value 1.

EVal2 

Enum value 2.

Definition at line 24 of file templateForC.h.

25 {
26 int EVal1, /**< Enum value 1 */
27 int EVal2 /**< Enum value 2 */
28 };
@ EVal1
Enum value 1.
Definition: templateForC.h:26
@ EVal2
Enum value 2.
Definition: templateForC.h:27

Function Documentation

◆ F1()

int F1 ( int  a1,
int &  r1 
)

F1.

This is function 1.

Returns
information about return value
See also
strcpy

The end!

Parameters
[in]a1some int. aasas. bbbb.
[in,out]r1integer input and some resulting value