\label{doc_contrib_api_reviews_core_keyClear_md_md_doc_contrib_api_reviews_core_keyClear}%
\Hypertarget{doc_contrib_api_reviews_core_keyClear_md_md_doc_contrib_api_reviews_core_keyClear}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/21 22\+:40
\item end = 2021-\/02-\/21 23\+:05
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md881}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md881}
{\ttfamily int \mbox{\hyperlink{group__key_gab2242311a36bbc0520e0d36895107ec1}{key\+Clear(\+Key $\ast$key)}}}\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md882}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md882}
\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md883}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md883}
(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{]} remove first line, second line could be improved a bit ~\newline
 (what is meant with internal data, exactly? is the name included?)
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Simple example or snippet how to use the function
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} be more explicit which data is actually included
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} very short sentences
\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}
key contains not internal data
\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{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} mark default case with {\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{]} maybe {\ttfamily \mbox{\hyperlink{group__key_ga3df95bbc2494e3e6703ece5639be5bb1}{key\+Del()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md884}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md884}

\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{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md885}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md885}
(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_keyClear_md_autotoc_md886}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md886}

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

\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 with {\ttfamily \mbox{\hyperlink{group__key_ga3df95bbc2494e3e6703ece5639be5bb1}{key\+Del()}}}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} No functions with similar purpose exist ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} new key\+Copy can also clear a key, maybe make {\ttfamily key\+Clear} an alias?
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md888}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md888}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function is easily extensible, e.\+g., with flags ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} could add flags for clearing parts of the key like {\ttfamily \mbox{\hyperlink{group__key_ga505575ebef060066984fe0f590081e37}{key\+Copy()}}}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Documentation does not impose limits, that would hinder further extensions
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md890}{}\doxysubsection{Tests}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md890}

\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_contrib_api_reviews_core_keyClear_md_autotoc_md891}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md891}
\hypertarget{doc_contrib_api_reviews_core_keyClear_md_autotoc_md892}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keyClear_md_autotoc_md892}
