Skip to content

Commit

Permalink
typo fix
Browse files Browse the repository at this point in the history
  • Loading branch information
kanndil committed Jan 20, 2025
1 parent eadbf1b commit 08a1cd7
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 8 deletions.
1 change: 0 additions & 1 deletion docs/doxygen/html/_e_f___u_a_r_t__example_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C file containing an example of how to use the UART APIs. </p>
<p>C header file containing an example of how to use the UART APIs.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac2f4a83425438348a71d343432ecdf37" name="ac2f4a83425438348a71d343432ecdf37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2f4a83425438348a71d343432ecdf37">&#9670;&#160;</a></span>EF_UART_EXAMPLE_C</h2>
Expand Down
7 changes: 6 additions & 1 deletion docs/doxygen/html/_e_f___u_a_r_t__example_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@
<div class="headertitle"><div class="title">EF_UART_example.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>C header file containing an example of how to use the UART APIs.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="_e_f___u_a_r_t_8h_source.html">EF_UART.h</a>&quot;</code><br />
</div>
<p><a href="_e_f___u_a_r_t__example_8h_source.html">Go to the source code of this file.</a></p>
Expand All @@ -84,7 +87,9 @@
<tr class="memdesc:a8451a75f6339b51e6239c6c4d01ee4e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Example Usage Example usage: <br /></td></tr>
<tr class="separator:a8451a75f6339b51e6239c6c4d01ee4e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C header file containing an example of how to use the UART APIs. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a8451a75f6339b51e6239c6c4d01ee4e0" name="a8451a75f6339b51e6239c6c4d01ee4e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8451a75f6339b51e6239c6c4d01ee4e0">&#9670;&#160;</a></span>EF_UART_example()</h2>

Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/html/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="_e_f___u_a_r_t_8c.html" target="_self">EF_UART.c</a></td><td class="desc">C file for UART APIs which contains the function implmentations </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="_e_f___u_a_r_t_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_e_f___u_a_r_t_8h.html" target="_self">EF_UART.h</a></td><td class="desc">C header file for UART APIs which contains the function prototypes </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="_e_f___u_a_r_t__example_8c.html" target="_self">EF_UART_example.c</a></td><td class="desc">C file containing an example of how to use the UART APIs </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="_e_f___u_a_r_t__example_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_e_f___u_a_r_t__example_8h.html" target="_self">EF_UART_example.h</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="_e_f___u_a_r_t__example_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_e_f___u_a_r_t__example_8h.html" target="_self">EF_UART_example.h</a></td><td class="desc">C header file containing an example of how to use the UART APIs </td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="_e_f___u_a_r_t__regs_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_e_f___u_a_r_t__regs_8h.html" target="_self">EF_UART_regs.h</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/latex/_e_f___u_a_r_t__example_8c.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
10 changes: 10 additions & 0 deletions docs/doxygen/latex/_e_f___u_a_r_t__example_8h.tex
Original file line number Diff line number Diff line change
@@ -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}
Expand All @@ -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}}
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/latex/files.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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}
1 change: 0 additions & 1 deletion docs/doxygen/xml/_e_f___u_a_r_t__example_8c.xml
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@
<para>C file containing an example of how to use the UART APIs. </para>
</briefdescription>
<detaileddescription>
<para>C header file containing an example of how to use the UART APIs.</para>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="comment">/*</highlight></codeline>
Expand Down
1 change: 1 addition & 0 deletions docs/doxygen/xml/_e_f___u_a_r_t__example_8h.xml
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@
</memberdef>
</sectiondef>
<briefdescription>
<para>C header file containing an example of how to use the UART APIs. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
Expand Down
2 changes: 1 addition & 1 deletion fw/EF_UART_example.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion fw/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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._
Expand Down

0 comments on commit 08a1cd7

Please sign in to comment.