diff --git a/docs/doxygen/html/_e_f___u_a_r_t__example_8c.html b/docs/doxygen/html/_e_f___u_a_r_t__example_8c.html index baa31ec..160d0ac 100644 --- a/docs/doxygen/html/_e_f___u_a_r_t__example_8c.html +++ b/docs/doxygen/html/_e_f___u_a_r_t__example_8c.html @@ -97,7 +97,6 @@

Detailed Description

C file containing an example of how to use the UART APIs.

-

C header file containing an example of how to use the UART APIs.

Macro Definition Documentation

◆ EF_UART_EXAMPLE_C

diff --git a/docs/doxygen/html/_e_f___u_a_r_t__example_8h.html b/docs/doxygen/html/_e_f___u_a_r_t__example_8h.html index 547a735..afca091 100644 --- a/docs/doxygen/html/_e_f___u_a_r_t__example_8h.html +++ b/docs/doxygen/html/_e_f___u_a_r_t__example_8h.html @@ -74,6 +74,9 @@
EF_UART_example.h File Reference
+ +

C header file containing an example of how to use the UART APIs. +More...

#include "EF_UART.h"

Go to the source code of this file.

@@ -84,7 +87,9 @@  Example Usage Example usage:
  -

Function Documentation

+

Detailed Description

+

C header file containing an example of how to use the UART APIs.

+

Function Documentation

◆ EF_UART_example()

diff --git a/docs/doxygen/html/files.html b/docs/doxygen/html/files.html index e161624..b09d98a 100644 --- a/docs/doxygen/html/files.html +++ b/docs/doxygen/html/files.html @@ -78,7 +78,7 @@  EF_UART.cC file for UART APIs which contains the function implmentations  EF_UART.hC header file for UART APIs which contains the function prototypes  EF_UART_example.cC file containing an example of how to use the UART APIs - EF_UART_example.h + EF_UART_example.hC header file containing an example of how to use the UART APIs  EF_UART_regs.h
diff --git a/docs/doxygen/latex/_e_f___u_a_r_t__example_8c.tex b/docs/doxygen/latex/_e_f___u_a_r_t__example_8c.tex index e56b62a..cbc4544 100644 --- a/docs/doxygen/latex/_e_f___u_a_r_t__example_8c.tex +++ b/docs/doxygen/latex/_e_f___u_a_r_t__example_8c.tex @@ -25,7 +25,7 @@ \doxysubsection{Detailed Description} C file containing an example of how to use the UART APIs. -C header file containing an example of how to use the UART APIs. + \doxysubsection{Macro Definition Documentation} \mbox{\Hypertarget{_e_f___u_a_r_t__example_8c_ac2f4a83425438348a71d343432ecdf37}\label{_e_f___u_a_r_t__example_8c_ac2f4a83425438348a71d343432ecdf37}} diff --git a/docs/doxygen/latex/_e_f___u_a_r_t__example_8h.tex b/docs/doxygen/latex/_e_f___u_a_r_t__example_8h.tex index c9e1c17..0868770 100644 --- a/docs/doxygen/latex/_e_f___u_a_r_t__example_8h.tex +++ b/docs/doxygen/latex/_e_f___u_a_r_t__example_8h.tex @@ -1,5 +1,10 @@ \hypertarget{_e_f___u_a_r_t__example_8h}{}\doxysection{EF\+\_\+\+UART\+\_\+example.\+h File Reference} \label{_e_f___u_a_r_t__example_8h}\index{EF\_UART\_example.h@{EF\_UART\_example.h}} + + +C header file containing an example of how to use the UART APIs. + + {\ttfamily \#include \char`\"{}EF\+\_\+\+UART.\+h\char`\"{}}\newline \doxysubsection*{Functions} \begin{DoxyCompactItemize} @@ -8,6 +13,11 @@ \begin{DoxyCompactList}\small\item\em Example Usage Example usage\+: \end{DoxyCompactList}\end{DoxyCompactItemize} +\doxysubsection{Detailed Description} +C header file containing an example of how to use the UART APIs. + + + \doxysubsection{Function Documentation} \mbox{\Hypertarget{_e_f___u_a_r_t__example_8h_a8451a75f6339b51e6239c6c4d01ee4e0}\label{_e_f___u_a_r_t__example_8h_a8451a75f6339b51e6239c6c4d01ee4e0}} \index{EF\_UART\_example.h@{EF\_UART\_example.h}!EF\_UART\_example@{EF\_UART\_example}} diff --git a/docs/doxygen/latex/files.tex b/docs/doxygen/latex/files.tex index 5566428..366df75 100644 --- a/docs/doxygen/latex/files.tex +++ b/docs/doxygen/latex/files.tex @@ -4,6 +4,6 @@ \item\contentsline{section}{\mbox{\hyperlink{_e_f___u_a_r_t_8c}{EF\+\_\+\+UART.\+c}} \\*C file for UART APIs which contains the function implmentations }{\pageref{_e_f___u_a_r_t_8c}}{} \item\contentsline{section}{\mbox{\hyperlink{_e_f___u_a_r_t_8h}{EF\+\_\+\+UART.\+h}} \\*C header file for UART APIs which contains the function prototypes }{\pageref{_e_f___u_a_r_t_8h}}{} \item\contentsline{section}{\mbox{\hyperlink{_e_f___u_a_r_t__example_8c}{EF\+\_\+\+UART\+\_\+example.\+c}} \\*C file containing an example of how to use the UART APIs }{\pageref{_e_f___u_a_r_t__example_8c}}{} -\item\contentsline{section}{\mbox{\hyperlink{_e_f___u_a_r_t__example_8h}{EF\+\_\+\+UART\+\_\+example.\+h}} }{\pageref{_e_f___u_a_r_t__example_8h}}{} +\item\contentsline{section}{\mbox{\hyperlink{_e_f___u_a_r_t__example_8h}{EF\+\_\+\+UART\+\_\+example.\+h}} \\*C header file containing an example of how to use the UART APIs }{\pageref{_e_f___u_a_r_t__example_8h}}{} \item\contentsline{section}{\mbox{\hyperlink{_e_f___u_a_r_t__regs_8h}{EF\+\_\+\+UART\+\_\+regs.\+h}} }{\pageref{_e_f___u_a_r_t__regs_8h}}{} \end{DoxyCompactList} diff --git a/docs/doxygen/xml/_e_f___u_a_r_t__example_8c.xml b/docs/doxygen/xml/_e_f___u_a_r_t__example_8c.xml index 7b6cee5..6b86de5 100644 --- a/docs/doxygen/xml/_e_f___u_a_r_t__example_8c.xml +++ b/docs/doxygen/xml/_e_f___u_a_r_t__example_8c.xml @@ -139,7 +139,6 @@ C file containing an example of how to use the UART APIs. -C header file containing an example of how to use the UART APIs. /* diff --git a/docs/doxygen/xml/_e_f___u_a_r_t__example_8h.xml b/docs/doxygen/xml/_e_f___u_a_r_t__example_8h.xml index 707c81a..dfbe987 100644 --- a/docs/doxygen/xml/_e_f___u_a_r_t__example_8h.xml +++ b/docs/doxygen/xml/_e_f___u_a_r_t__example_8h.xml @@ -109,6 +109,7 @@ +C header file containing an example of how to use the UART APIs. diff --git a/fw/EF_UART_example.h b/fw/EF_UART_example.h index 38d1512..031d210 100644 --- a/fw/EF_UART_example.h +++ b/fw/EF_UART_example.h @@ -17,7 +17,7 @@ */ -/*! \file EF_UART_example.c +/*! \file EF_UART_example.h \brief C header file containing an example of how to use the UART APIs */ diff --git a/fw/README.md b/fw/README.md index e33cf79..8c1de85 100644 --- a/fw/README.md +++ b/fw/README.md @@ -1306,7 +1306,7 @@ status A value of type [**EF\_DRIVER\_STATUS**](#typedef-ef_driver_status) : ret ## File EF_UART_example.h - +_C header file containing an example of how to use the UART APIs._