\label{doc_contrib_api_reviews_core_keyIsLocked_md_md_doc_contrib_api_reviews_core_keyIsLocked}%
\Hypertarget{doc_contrib_api_reviews_core_keyIsLocked_md_md_doc_contrib_api_reviews_core_keyIsLocked}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/21 22\+:15
\item end = 2021-\/02-\/21 22\+:40
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1202}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1202}
{\ttfamily int key\+Is\+Locked (const Key $\ast$ key, elektra\+Lock\+Flags what)}\hypertarget{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1203}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1203}
\hypertarget{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1204}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1204}
(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{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add better description or reference to {\ttfamily key\+Locked()}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily key} stays unchanged
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

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

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} change default case to {\ttfamily @return}
\end{DoxyItemize}
\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 \mbox{[} \mbox{]} move to bottom
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1205}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1205}

\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 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_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1206}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1206}
(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_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1207}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1207}

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

\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_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1209}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1209}

\begin{DoxyItemize}
\item Memory Management should be handled by the function wherever possible
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1210}{}\doxysubsection{Extensibility}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1210}

\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{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1211}{}\doxysubsection{Tests}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1211}

\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 for null pointer return value
\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_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1212}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1212}
\hypertarget{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1213}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keyIsLocked_md_autotoc_md1213}
