\label{doc_api_review_core_keyLock_md_md_doc_api_review_core_keyLock}%
\Hypertarget{doc_api_review_core_keyLock_md_md_doc_api_review_core_keyLock}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/21 21\+:45
\item end = 2021-\/02-\/21 22\+:05
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1060}{}\doxysection{Signature}\label{doc_api_review_core_keyLock_md_autotoc_md1060}
{\ttfamily int key\+Lock (Key $\ast$ key, elektra\+Lock\+Flags what)}\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1061}{}\doxysection{Checklist}\label{doc_api_review_core_keyLock_md_autotoc_md1061}
\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1062}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyLock_md_autotoc_md1062}
(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{[}x\mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} key is a valid key ~\newline

\item \mbox{[}x\mbox{]} what contains valid elektra\+Lock\+Flags
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} parts of the keys, as stated in the what-\/parameter, are locked
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} key stays a valid key
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} key ~\newline

\item \mbox{[} \mbox{]} what
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move above see also ~\newline

\item \mbox{[} \mbox{]} move {\ttfamily $>$0} to default case ({\ttfamily @return})
\end{DoxyItemize}
\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{[} \mbox{]} {\ttfamily @see} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__key_ga769882e86e34a95cefcf8f260ef97e06}{key\+Is\+Locked()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1063}{}\doxysubsection{Naming}\label{doc_api_review_core_keyLock_md_autotoc_md1063}

\begin{DoxyItemize}
\item 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{[} \mbox{]} Parameter names should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} rename what to flags?
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1064}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyLock_md_autotoc_md1064}
(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_keyLock_md_autotoc_md1065}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyLock_md_autotoc_md1065}

\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{[}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_keyLock_md_autotoc_md1066}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyLock_md_autotoc_md1066}

\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{]} move below {\ttfamily \mbox{\hyperlink{group__key_ga0d82ce48529821aa43d82c035ba30c4f}{key\+Get\+Ref()}}}-\/family of functions
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1067}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyLock_md_autotoc_md1067}

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

\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{]} keys cannot be unlocked
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1069}{}\doxysubsection{Tests}\label{doc_api_review_core_keyLock_md_autotoc_md1069}

\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{[}x\mbox{]} test null pointer
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} 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_keyLock_md_autotoc_md1070}{}\doxysection{Summary}\label{doc_api_review_core_keyLock_md_autotoc_md1070}
Also check return values of function in tests\hypertarget{doc_api_review_core_keyLock_md_autotoc_md1071}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyLock_md_autotoc_md1071}
