\label{doc_api_review_core_keyDel_md_md_doc_api_review_core_keyDel}%
\Hypertarget{doc_api_review_core_keyDel_md_md_doc_api_review_core_keyDel}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/14 03\+:55
\item end = 2021-\/02-\/14 04\+:25
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDel_md_autotoc_md812}{}\doxysection{Signature}\label{doc_api_review_core_keyDel_md_autotoc_md812}
{\ttfamily int \mbox{\hyperlink{group__key_ga3df95bbc2494e3e6703ece5639be5bb1}{key\+Del(\+Key $\ast$key)}}}\hypertarget{doc_api_review_core_keyDel_md_autotoc_md813}{}\doxysection{Checklist}\label{doc_api_review_core_keyDel_md_autotoc_md813}
\hypertarget{doc_api_review_core_keyDel_md_autotoc_md814}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyDel_md_autotoc_md814}
(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 example
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Longer description of function containing common use cases
\item \mbox{[}x\mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \begin{DoxyPrecond}{Precondition}
Key must not be null
\end{DoxyPrecond}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \begin{DoxyPostcond}{Postcondition}
Key memory has been freed
\end{DoxyPostcond}

\end{DoxyItemize}
\item \mbox{[} \mbox{]} \`{}\begin{DoxyInvariant}{Invariant}
~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add (tbd)
\end{DoxyItemize}
\end{DoxyInvariant}

\item \mbox{[}x\mbox{]} {\ttfamily @param} for every parameter
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily 0} when the key was freed and no references are held in keysets
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Abbreviations used in function names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\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{[}x\mbox{]} Abbreviations used in parameter names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\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
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDel_md_autotoc_md816}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyDel_md_autotoc_md816}
(only in PRs)


\begin{DoxyItemize}
\item \mbox{\hyperlink{doc_dev_symbol-versioning_md}{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{doc_api_review_core_keyDel_md_autotoc_md817}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyDel_md_autotoc_md817}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} 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{[} \mbox{]} Wherever possible, return types should be {\ttfamily const} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} could maybe change this to const
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Functions should have the least amount of parameters feasible
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDel_md_autotoc_md818}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyDel_md_autotoc_md818}

\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{]} swap key\+Clear and key\+Del
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDel_md_autotoc_md819}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyDel_md_autotoc_md819}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[} \mbox{]} Documentation does not impose limits, that would hinder further extensions ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} TBD cannot change behavior of referenced keys
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDel_md_autotoc_md821}{}\doxysubsection{Tests}\label{doc_api_review_core_keyDel_md_autotoc_md821}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function code is fully covered by tests
\item \mbox{[}x\mbox{]} All possible error states are covered by tests
\item All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDel_md_autotoc_md822}{}\doxysection{Summary}\label{doc_api_review_core_keyDel_md_autotoc_md822}
\hypertarget{doc_api_review_core_keyDel_md_autotoc_md823}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyDel_md_autotoc_md823}
