From 01fd16f51169504e5728ae3e733f8cfcc7f19657 Mon Sep 17 00:00:00 2001 From: Youssef Kandil Date: Sun, 12 Jan 2025 16:41:22 +0200 Subject: [PATCH] added project name --- .../html/_e_f___driver___common_8h.html | 176 +- .../_e_f___driver___common_8h_source.html | 4 +- docs/doxygen/html/_e_f___u_a_r_t_8c.html | 286 +-- docs/doxygen/html/_e_f___u_a_r_t_8h.html | 490 ++-- .../html/_e_f___u_a_r_t_8h_source.html | 45 +- .../doxygen/html/_e_f___u_a_r_t__regs_8h.html | 191 +- .../html/_e_f___u_a_r_t__regs_8h_source.html | 166 +- docs/doxygen/html/annotated.html | 4 +- docs/doxygen/html/classes.html | 4 +- docs/doxygen/html/example_8c.html | 253 +++ docs/doxygen/html/files.html | 9 +- docs/doxygen/html/globals.html | 107 +- docs/doxygen/html/globals_defs.html | 78 +- docs/doxygen/html/globals_func.html | 15 +- docs/doxygen/html/globals_type.html | 6 +- docs/doxygen/html/index.html | 6 +- docs/doxygen/html/md__r_e_a_d_m_e.html | 761 ++++--- docs/doxygen/html/menudata.js | 27 +- docs/doxygen/html/pages.html | 4 +- docs/doxygen/html/search/all_0.js | 5 +- docs/doxygen/html/search/all_2.js | 56 +- docs/doxygen/html/search/all_3.js | 219 +- docs/doxygen/html/search/all_6.js | 5 +- docs/doxygen/html/search/all_d.js | 4 +- docs/doxygen/html/search/defines_0.js | 10 +- docs/doxygen/html/search/defines_1.js | 119 +- docs/doxygen/html/search/defines_3.js | 4 + docs/doxygen/html/search/files_0.js | 4 +- docs/doxygen/html/search/functions_1.js | 4 + docs/doxygen/html/search/functions_2.js | 5 + docs/doxygen/html/search/searchdata.js | 31 +- docs/doxygen/html/search/typedefs_0.js | 4 +- ...t___e_f___u_a_r_t___t_y_p_e__-members.html | 46 +- .../struct___e_f___u_a_r_t___t_y_p_e__.html | 364 ++- .../latex/_e_f___driver___common_8h.tex | 110 +- docs/doxygen/latex/_e_f___u_a_r_t_8c.tex | 272 +-- docs/doxygen/latex/_e_f___u_a_r_t_8h.tex | 404 ++-- .../latex/_e_f___u_a_r_t_8h_source.tex | 6 +- .../doxygen/latex/_e_f___u_a_r_t__regs_8h.tex | 181 +- .../latex/_e_f___u_a_r_t__regs_8h_source.tex | 48 +- docs/doxygen/latex/example_8c.tex | 55 + docs/doxygen/latex/files.tex | 5 +- docs/doxygen/latex/md__r_e_a_d_m_e.tex | 748 +++---- docs/doxygen/latex/refman.aux | 1009 +++++---- docs/doxygen/latex/refman.fdb_latexmk | 47 +- docs/doxygen/latex/refman.fls | 53 +- docs/doxygen/latex/refman.idx | 549 +++-- docs/doxygen/latex/refman.ilg | 6 +- docs/doxygen/latex/refman.ind | 694 ++++-- docs/doxygen/latex/refman.log | 1917 ++++++++-------- docs/doxygen/latex/refman.pdf | Bin 347125 -> 402284 bytes docs/doxygen/latex/refman.synctex.gz | Bin 585230 -> 688173 bytes docs/doxygen/latex/refman.tex | 7 +- docs/doxygen/latex/refman.toc | 365 +-- .../struct___e_f___u_a_r_t___t_y_p_e__.tex | 198 +- .../doxygen/xml/_e_f___driver___common_8h.xml | 98 +- docs/doxygen/xml/_e_f___u_a_r_t_8c.xml | 1862 ++++++++-------- docs/doxygen/xml/_e_f___u_a_r_t_8h.xml | 612 +++-- docs/doxygen/xml/_e_f___u_a_r_t__regs_8h.xml | 406 ++-- docs/doxygen/xml/_r_e_a_d_m_e_8md.xml | 1695 ++++++++++---- docs/doxygen/xml/example_8c.xml | 277 +++ docs/doxygen/xml/index.xml | 184 +- docs/doxygen/xml/md__r_e_a_d_m_e.xml | 1977 +++++++++++++---- .../struct___e_f___u_a_r_t___t_y_p_e__.xml | 44 +- fw/Doxyfile | 2 +- 65 files changed, 10989 insertions(+), 6354 deletions(-) create mode 100644 docs/doxygen/html/example_8c.html create mode 100644 docs/doxygen/html/search/defines_3.js create mode 100644 docs/doxygen/html/search/functions_1.js create mode 100644 docs/doxygen/html/search/functions_2.js create mode 100644 docs/doxygen/latex/example_8c.tex create mode 100644 docs/doxygen/xml/example_8c.xml diff --git a/docs/doxygen/html/_e_f___driver___common_8h.html b/docs/doxygen/html/_e_f___driver___common_8h.html index 17d8e9c..9f8b58f 100644 --- a/docs/doxygen/html/_e_f___driver___common_8h.html +++ b/docs/doxygen/html/_e_f___driver___common_8h.html @@ -5,7 +5,7 @@ -My Project: EF_Driver_Common.h File Reference +EF_UART APIs: EF_Driver_Common.h File Reference @@ -21,7 +21,7 @@ -
My Project +
EF_UART APIs
@@ -86,45 +86,167 @@ - - + + - - + + - - + + - - + + - - + + - - + + - - + +

Macros

-#define EF_DRIVER_OK   ((uint32_t)0)
 Operation succeeded.
#define EF_DRIVER_OK   ((uint32_t)0)
 Operation succeeded.
 
-#define EF_DRIVER_ERROR   ((uint32_t)1)
 Unspecified error.
#define EF_DRIVER_ERROR   ((uint32_t)1)
 Unspecified error.
 
-#define EF_DRIVER_ERROR_BUSY   ((uint32_t)2)
 Driver is busy.
#define EF_DRIVER_ERROR_BUSY   ((uint32_t)2)
 Driver is busy.
 
-#define EF_DRIVER_ERROR_TIMEOUT   ((uint32_t)3)
 Timeout occurred.
#define EF_DRIVER_ERROR_TIMEOUT   ((uint32_t)3)
 Timeout occurred.
 
-#define EF_DRIVER_ERROR_UNSUPPORTED   ((uint32_t)4)
 Operation not supported.
#define EF_DRIVER_ERROR_UNSUPPORTED   ((uint32_t)4)
 Operation not supported.
 
-#define EF_DRIVER_ERROR_PARAMETER   ((uint32_t)5)
 Parameter error.
#define EF_DRIVER_ERROR_PARAMETER   ((uint32_t)5)
 Parameter error.
 
-#define EF_DRIVER_ERROR_SPECIFIC   ((uint32_t)6)
 Start of driver specific errors.
#define EF_DRIVER_ERROR_SPECIFIC   ((uint32_t)6)
 Start of driver specific errors.
 
- - + +

Typedefs

-typedef uint32_t EF_DRIVER_STATUS
 A type that is used to return the status of the driver functions.
typedef uint32_t EF_DRIVER_STATUS
 A type that is used to return the status of the driver functions.
 

Detailed Description

C header file for common driver definitions and types.

-
+

Macro Definition Documentation

+ +

◆ EF_DRIVER_ERROR

+ +
+
+ + + + +
#define EF_DRIVER_ERROR   ((uint32_t)1)
+
+ +

Unspecified error.

+ +
+
+ +

◆ EF_DRIVER_ERROR_BUSY

+ +
+
+ + + + +
#define EF_DRIVER_ERROR_BUSY   ((uint32_t)2)
+
+ +

Driver is busy.

+ +
+
+ +

◆ EF_DRIVER_ERROR_PARAMETER

+ +
+
+ + + + +
#define EF_DRIVER_ERROR_PARAMETER   ((uint32_t)5)
+
+ +

Parameter error.

+ +
+
+ +

◆ EF_DRIVER_ERROR_SPECIFIC

+ +
+
+ + + + +
#define EF_DRIVER_ERROR_SPECIFIC   ((uint32_t)6)
+
+ +

Start of driver specific errors.

+ +
+
+ +

◆ EF_DRIVER_ERROR_TIMEOUT

+ +
+
+ + + + +
#define EF_DRIVER_ERROR_TIMEOUT   ((uint32_t)3)
+
+ +

Timeout occurred.

+ +
+
+ +

◆ EF_DRIVER_ERROR_UNSUPPORTED

+ +
+
+ + + + +
#define EF_DRIVER_ERROR_UNSUPPORTED   ((uint32_t)4)
+
+ +

Operation not supported.

+ +
+
+ +

◆ EF_DRIVER_OK

+ +
+
+ + + + +
#define EF_DRIVER_OK   ((uint32_t)0)
+
+ +

Operation succeeded.

+ +
+
+

Typedef Documentation

+ +

◆ EF_DRIVER_STATUS

+ +
+
+ + + + +
typedef uint32_t EF_DRIVER_STATUS
+
+ +

A type that is used to return the status of the driver functions.

+ +
+
+