Logo

SAMPLE  1.0

PRF R&D COMPANY


doxygen_sw_v1r0_00.c File Reference

Main file of this sample. More...

Go to the source code of this file.

[[|]] Data Structures edit

struct   struct_1   struct   struct_link  

[[|]] Macros edit

  1. define 

MAX(A, B)   A>B ? A:B   Find max variable. More...

 

  1. define 

MY_ERR_CANNOT_OPEN_FILE   101  

  1. define 

MY_ERR_CANNOT_CLOSE_FILE   102  

[[|]] Typedefs edit

typedef enum enum_1  enum_1   Use brief, otherwise the index won't have a brief explanation. Detailed explanation. More...

  typedef struct struct_1  struct_1   typedef struct struct_link  struct_link  

[[|]] Enumerations edit

enum   enum_1 { enum_a, enum_b, enum_c }   Use brief, otherwise the index won't have a brief explanation. Detailed explanation. More...

 

[[|]] Functions edit

void  func_1 ()   void  func_2 ()   void  func_3 ()   int  func_4 (int param_1, int param_2, int *param_3)   void  test ()   void  call_func11 (void)   void  call_func1 (void)  

[[|]] Variables edit

int  var_a   var1 in group 1 More...

  int  var_b   var2 in group 1 More...

  int  var_c   Var1 and Var2. More...

  int  var_a1   int  var_b1   int  var_c1   int  var_a2   this is var_a2 More...

  int  var_b2   this is var_b2 More...

  int  var_c2   this is var_c2 More...

  [[|]]

Detailed Description edit

Main file of this sample.

Definition in file doxygen_sw_v1r0_00.c.


Macro Definition Documentation edit

[[|]]

◆ MAX edit

#define MAX (   A,
 
)    A>B ? A:B


Find max variable.

Definition at line 166 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ MY_ERR_CANNOT_CLOSE_FILE edit

#define MY_ERR_CANNOT_CLOSE_FILE   102


\:
ERROR 102: in case a file can not be closed. Check about file system read/write access.

Definition at line 245 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ MY_ERR_CANNOT_OPEN_FILE edit

#define MY_ERR_CANNOT_OPEN_FILE   101


\:
ERROR 101: in case a file can not be opened. Check about file system read/write access.

Definition at line 242 of file doxygen_sw_v1r0_00.c.


Typedef Documentation edit

[[|]]

◆ enum_1 edit

typedef enum enum_1 enum_1


Use brief, otherwise the index won't have a brief explanation. Detailed explanation.


[[|]]

◆ struct_1 edit

typedef struct struct_1 struct_1



[[|]]

◆ struct_link edit

typedef struct struct_link struct_link



Enumeration Type Documentation edit

[[|]]

◆ enum_1 edit

enum enum_1


Use brief, otherwise the index won't have a brief explanation. Detailed explanation.

Enumerator [[|]]enum_a  Some documentation for first.

[[|]]enum_b  Some documentation for second.

[[|]]enum_c  Etc.

Definition at line 135 of file doxygen_sw_v1r0_00.c.


Function Documentation edit

[[|]]

◆ call_func1() edit

void call_func1 ( void  )


Definition at line 284 of file doxygen_sw_v1r0_00.c.

Here is the call graph for this function:

[[|]]

◆ call_func11() edit

void call_func11 ( void  )


Short overview is here.

Definition at line 280 of file doxygen_sw_v1r0_00.c.

Here is the caller graph for this function:

[[|]]

◆ func_4() edit

int func_4 ( int  param_1,
int  param_2,
int *  param_3 
)


Parameters
{| | param_1 | Some documentation for param_1 |- | param_2 | Some documentation for param_2 |}

< Some documentation for the line
< Some documentation for the line

Definition at line 156 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ test() edit

void test ( )


User defined paragraph
Contents of the paragraph.

If condition is set, it displays. /*!


Variable Documentation edit

[[|]]

◆ var_a1 edit

int var_a1


Definition at line 114 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ var_a2 edit

var_a2


this is var_a2

Definition at line 127 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ var_b1 edit

int var_b1


Definition at line 115 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ var_b2 edit

var_b2


this is var_b2

Definition at line 128 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ var_c1 edit

int var_c1


Definition at line 116 of file doxygen_sw_v1r0_00.c.


[[|]]

◆ var_c2 edit

var_c2


this is var_c2

Definition at line 129 of file doxygen_sw_v1r0_00.c.



Generated by  doxygen 1.8.14