Merge pull request #1 from Detailer/master

Initialized Doxygen, Added description to functions and formated files

1 files changed, 78 insertions, 0 deletions

diff --git a/doc/latex/thirdparty_2linux_2include_2fun_8h.tex b/doc/latex/thirdparty_2linux_2include_2fun_8h.tex
new file mode 100644
index 0000000..ea369bc
--- /dev/null
+++ b/doc/latex/thirdparty_2linux_2include_2fun_8h.tex
@@ -0,0 +1,78 @@
+\hypertarget{thirdparty_2linux_2include_2fun_8h}{}\doxysection{thirdparty/linux/include/fun.h File Reference}
+\label{thirdparty_2linux_2include_2fun_8h}\index{thirdparty/linux/include/fun.h@{thirdparty/linux/include/fun.h}}
+\doxysubsection*{Classes}
+\begin{DoxyCompactItemize}
+\item 
+struct \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}}
+\item 
+struct \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}}
+\end{DoxyCompactItemize}
+\doxysubsection*{Macros}
+\begin{DoxyCompactItemize}
+\item 
+\#define \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a2ca3f7142a7018d5861959828144a9e9}{fun\+\_\+h\+\_\+\+\_\+}}
+\end{DoxyCompactItemize}
+\doxysubsection*{Enumerations}
+\begin{DoxyCompactItemize}
+\item 
+enum \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} \{ \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}{TYPE\+\_\+\+DOUBLE}}
+, \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}{TYPE\+\_\+\+STRING}}
+, \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}{TYPE\+\_\+\+DOUBLE}}
+, \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}{TYPE\+\_\+\+STRING}}
+ \}
+\end{DoxyCompactItemize}
+\doxysubsection*{Functions}
+\begin{DoxyCompactItemize}
+\item 
+int \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_adda0eaf7454844236de53495b494cdd4}{fun}} (\mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} $\ast$arr, \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} $\ast$call)
+\begin{DoxyCompactList}\small\item\em Function to Interact with Octave\textquotesingle{}s API. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\doxysubsection{Macro Definition Documentation}
+\mbox{\Hypertarget{thirdparty_2linux_2include_2fun_8h_a2ca3f7142a7018d5861959828144a9e9}\label{thirdparty_2linux_2include_2fun_8h_a2ca3f7142a7018d5861959828144a9e9}} 
+\index{fun.h@{fun.h}!fun\_h\_\_@{fun\_h\_\_}}
+\index{fun\_h\_\_@{fun\_h\_\_}!fun.h@{fun.h}}
+\doxysubsubsection{\texorpdfstring{fun\_h\_\_}{fun\_h\_\_}}
+{\footnotesize\ttfamily \#define fun\+\_\+h\+\_\+\+\_\+}
+
+
+
+\doxysubsection{Enumeration Type Documentation}
+\mbox{\Hypertarget{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134}\label{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134}} 
+\index{fun.h@{fun.h}!FUNCTYPE@{FUNCTYPE}}
+\index{FUNCTYPE@{FUNCTYPE}!fun.h@{fun.h}}
+\doxysubsubsection{\texorpdfstring{FUNCTYPE}{FUNCTYPE}}
+{\footnotesize\ttfamily enum \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}}}
+
+\begin{DoxyEnumFields}{Enumerator}
+\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_DOUBLE@{TYPE\_DOUBLE}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_DOUBLE@{TYPE\_DOUBLE}}}\mbox{\Hypertarget{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}\label{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}} 
+TYPE\+\_\+\+DOUBLE&\\
+\hline
+
+\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_STRING@{TYPE\_STRING}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_STRING@{TYPE\_STRING}}}\mbox{\Hypertarget{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}\label{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}} 
+TYPE\+\_\+\+STRING&\\
+\hline
+
+\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_DOUBLE@{TYPE\_DOUBLE}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_DOUBLE@{TYPE\_DOUBLE}}}\mbox{\Hypertarget{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}\label{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}} 
+TYPE\+\_\+\+DOUBLE&\\
+\hline
+
+\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_STRING@{TYPE\_STRING}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_STRING@{TYPE\_STRING}}}\mbox{\Hypertarget{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}\label{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}} 
+TYPE\+\_\+\+STRING&\\
+\hline
+
+\end{DoxyEnumFields}
+
+
+\doxysubsection{Function Documentation}
+\mbox{\Hypertarget{thirdparty_2linux_2include_2fun_8h_adda0eaf7454844236de53495b494cdd4}\label{thirdparty_2linux_2include_2fun_8h_adda0eaf7454844236de53495b494cdd4}} 
+\index{fun.h@{fun.h}!fun@{fun}}
+\index{fun@{fun}!fun.h@{fun.h}}
+\doxysubsubsection{\texorpdfstring{fun()}{fun()}}
+{\footnotesize\ttfamily int fun (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} $\ast$}]{inp,  }\item[{\mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} $\ast$}]{funcall }\end{DoxyParamCaption})}
+
+
+
+Function to Interact with Octave\textquotesingle{}s API. 
+
+This Function will be communicating with Octave to access it\textquotesingle{}s function. 
\ No newline at end of file