api largely finished, polish and comments still needed.
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
\doxysection{source\+\_\+code/\+MODULE\+\_\+marigold\+\_\+dynamic\+\_\+array/internal/internal\+\_\+marigold\+\_\+dynamic\+\_\+array.h File Reference}
|
||||
\hypertarget{internal__marigold__dynamic__array_8h}{}\label{internal__marigold__dynamic__array_8h}\index{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.h@{source\_code/MODULE\_marigold\_dynamic\_array/internal/internal\_marigold\_dynamic\_array.h}}
|
||||
\doxysubsubsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
void \mbox{\hyperlink{internal__marigold__dynamic__array_8h_a080efb0189640763472b0b75fd85ccb9}{dynamic\+\_\+array\+\_\+destroy}} (\mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}array)
|
||||
\begin{DoxyCompactList}\small\item\em Destroy a dynamic array and free its memory. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Function Documentation}
|
||||
\Hypertarget{internal__marigold__dynamic__array_8h_a080efb0189640763472b0b75fd85ccb9}\label{internal__marigold__dynamic__array_8h_a080efb0189640763472b0b75fd85ccb9}
|
||||
\index{internal\_marigold\_dynamic\_array.h@{internal\_marigold\_dynamic\_array.h}!dynamic\_array\_destroy@{dynamic\_array\_destroy}}
|
||||
\index{dynamic\_array\_destroy@{dynamic\_array\_destroy}!internal\_marigold\_dynamic\_array.h@{internal\_marigold\_dynamic\_array.h}}
|
||||
\doxysubsubsection{\texorpdfstring{dynamic\_array\_destroy()}{dynamic\_array\_destroy()}}
|
||||
{\footnotesize\ttfamily void dynamic\+\_\+array\+\_\+destroy (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structdynamic__array}{dynamic\+\_\+array}} \texorpdfstring{$\ast$}{*}}]{array }\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Destroy a dynamic array and free its memory.
|
||||
|
||||
Frees the memory block and the array structure itself. Sets owner\+\_\+count to 0 before freeing.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em array} & Pointer to the \doxylink{structdynamic__array}{dynamic\+\_\+array} to destroy. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
Reference in New Issue
Block a user