\label{doc_api_review_core_keyDecRef_md_md_doc_api_review_core_keyDecRef}%
\Hypertarget{doc_api_review_core_keyDecRef_md_md_doc_api_review_core_keyDecRef}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/21 21\+:10
\item end = 2021-\/02-\/21 21\+:25
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDecRef_md_autotoc_md827}{}\doxysection{Signature}\label{doc_api_review_core_keyDecRef_md_autotoc_md827}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__key_ga0c4d031ab6ee02cf884c64e28a2ad151}{key\+Dec\+Ref(\+Key $\ast$key)}}}\hypertarget{doc_api_review_core_keyDecRef_md_autotoc_md828}{}\doxysection{Checklist}\label{doc_api_review_core_keyDecRef_md_autotoc_md828}
\hypertarget{doc_api_review_core_keyDecRef_md_autotoc_md829}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyDecRef_md_autotoc_md829}
(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} First line explains briefly what the function does ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} change viability to reference counter
\end{DoxyItemize}
\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{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} description seems a bit unclear when reading
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} \begin{DoxyPrecond}{Precondition}
key is a valid key
\end{DoxyPrecond}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} \begin{DoxyPostcond}{Postcondition}
reference counter of the key is decremented by one
\end{DoxyPostcond}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} \begin{DoxyInvariant}{Invariant}
key stays a valid key
\end{DoxyInvariant}

\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{[}x\mbox{]} {\ttfamily @ingroup}
\item \mbox{[} \mbox{]} {\ttfamily @see} ~\newline

\begin{DoxyItemize}
\item split to multiple lines
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDecRef_md_autotoc_md830}{}\doxysubsection{Naming}\label{doc_api_review_core_keyDecRef_md_autotoc_md830}

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

\begin{DoxyItemize}
\item add dec to glossary ~\newline

\item add ref to glossary
\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 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_keyDecRef_md_autotoc_md831}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyDecRef_md_autotoc_md831}
(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_keyDecRef_md_autotoc_md832}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyDecRef_md_autotoc_md832}

\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{doc_api_review_core_keyDecRef_md_autotoc_md833}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyDecRef_md_autotoc_md833}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Functions should do exactly one thing
\item \mbox{[}x\mbox{]} Function name has the appropriate prefix
\item \mbox{[}x\mbox{]} Order of signatures in kdb.\+h.\+in is the same as Doxygen
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyDecRef_md_autotoc_md834}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyDecRef_md_autotoc_md834}

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

\begin{DoxyItemize}
\item 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{doc_api_review_core_keyDecRef_md_autotoc_md836}{}\doxysubsection{Tests}\label{doc_api_review_core_keyDecRef_md_autotoc_md836}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function code is fully covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} test decrementing key with reference counter = 0
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} test decrementing key with reference counter = 0 ~\newline

\item \mbox{[}x\mbox{]} test null pointer
\end{DoxyItemize}
\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_keyDecRef_md_autotoc_md837}{}\doxysection{Summary}\label{doc_api_review_core_keyDecRef_md_autotoc_md837}
\hypertarget{doc_api_review_core_keyDecRef_md_autotoc_md838}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyDecRef_md_autotoc_md838}
