
\begin{DoxyItemize}
\item start = 2021-\/03-\/09 02\+:10
\item end = 2021-\/03-\/09 02\+:20
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1391}{}\doxysection{Signature}\label{md_doc_api_review_core_ksDel_autotoc_md1391}
{\ttfamily int \mbox{\hyperlink{group__keyset_ga27e5c16473b02a422238c8d970db7ac8}{ks\+Del(\+Key\+Set $\ast$ks)}}}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1392}{}\doxysection{Checklist}\label{md_doc_api_review_core_ksDel_autotoc_md1392}
\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1393}{}\doxysubsubsection{Doxygen}\label{md_doc_api_review_core_ksDel_autotoc_md1393}
(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} First line explains briefly what the function does
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Longer description of function containing common use cases
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} fix {\ttfamily \mbox{\hyperlink{internal_8c_a7f572149d2e0bfe18023a6ac969f195c}{elektra\+Free()}}} ref ~\newline

\item \mbox{[} \mbox{]} \textquotesingle{}the release the\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @param} for every parameter
\item \mbox{[}x\mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @ingroup} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @see}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1394}{}\doxysubsection{Naming}\label{md_doc_api_review_core_ksDel_autotoc_md1394}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Abbreviations used in function names must be defined in the Glossary ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} define {\ttfamily ks}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Function names should neither be too long, nor too short
\item \mbox{[}x\mbox{]} Function name should be clear and unambiguous
\item \mbox{[} \mbox{]} Abbreviations used in parameter names must be defined in the Glossary ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} define {\ttfamily ks}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Parameter names should neither be too long, nor too short
\item \mbox{[}x\mbox{]} Parameter names should be clear and unambiguous -\/ \mbox{[} \mbox{]} ks -\/$>$ key\+Set
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1395}{}\doxysubsection{Compatibility}\label{md_doc_api_review_core_ksDel_autotoc_md1395}
(only in PRs)


\begin{DoxyItemize}
\item Symbol versioning is correct for breaking changes
\item ABI/\+API changes are forward-\/compatible (breaking backwards-\/compatibility to add additional symbols is fine)
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1396}{}\doxysubsection{Parameter \& Return Types}\label{md_doc_api_review_core_ksDel_autotoc_md1396}

\begin{DoxyItemize}
\item Function parameters should use enum types instead of boolean types wherever sensible
\item \mbox{[}x\mbox{]} Wherever possible, function parameters should be {\ttfamily const}
\item \mbox{[}x\mbox{]} Wherever possible, return types should be {\ttfamily const}
\item \mbox{[}x\mbox{]} Functions should have the least amount of parameters feasible
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1397}{}\doxysubsection{Structural Clarity}\label{md_doc_api_review_core_ksDel_autotoc_md1397}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Functions should do exactly one thing
\item \mbox{[}x\mbox{]} Function name has the appropriate prefix
\item \mbox{[} \mbox{]} Order of signatures in kdb.\+h.\+in is the same as Doxygen ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} fix
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1398}{}\doxysubsection{Memory Management}\label{md_doc_api_review_core_ksDel_autotoc_md1398}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Memory Management should be handled by the function wherever possible
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1399}{}\doxysubsection{Extensibility}\label{md_doc_api_review_core_ksDel_autotoc_md1399}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[}x\mbox{]} Documentation does not impose limits, that would hinder further extensions
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1400}{}\doxysubsection{Tests}\label{md_doc_api_review_core_ksDel_autotoc_md1400}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function code is fully covered by tests
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add test for {\ttfamily keyset == NULL}
\end{DoxyItemize}
\item All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1401}{}\doxysection{Summary}\label{md_doc_api_review_core_ksDel_autotoc_md1401}
\hypertarget{md_doc_api_review_core_ksDel_autotoc_md1402}{}\doxysection{Other Issues discovered (unrelated to function)}\label{md_doc_api_review_core_ksDel_autotoc_md1402}
