\label{doc_api_review_core_ksClear_md_md_doc_api_review_core_ksClear}%
\Hypertarget{doc_api_review_core_ksClear_md_md_doc_api_review_core_ksClear}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/20 17\+:50
\item end = 2021-\/03-\/20 17\+:50
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1307}{}\doxysection{Signature}\label{doc_api_review_core_ksClear_md_autotoc_md1307}
{\ttfamily int \mbox{\hyperlink{group__keyset_ga304d5770a30ef760d1b6d4bcd13f1ece}{ks\+Clear(\+Key\+Set $\ast$ks)}}}\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1308}{}\doxysection{Checklist}\label{doc_api_review_core_ksClear_md_autotoc_md1308}
\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1309}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_ksClear_md_autotoc_md1309}
(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} First line explains briefly what the function does
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function
\item \mbox{[} \mbox{]} Longer description of function containing common use cases
\item \mbox{[} \mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre}
\item \mbox{[} \mbox{]} {\ttfamily @post}
\item \mbox{[} \mbox{]} {\ttfamily @invariant}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\item \mbox{[} \mbox{]} {\ttfamily @since}
\item \mbox{[} \mbox{]} {\ttfamily @ingroup}
\item \mbox{[} \mbox{]} {\ttfamily @see}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1310}{}\doxysubsection{Naming}\label{doc_api_review_core_ksClear_md_autotoc_md1310}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Abbreviations used in function names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\item \mbox{[} \mbox{]} Function names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Function name should be clear and unambiguous
\item \mbox{[} \mbox{]} Abbreviations used in parameter names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\item \mbox{[} \mbox{]} Parameter names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1311}{}\doxysubsection{Compatibility}\label{doc_api_review_core_ksClear_md_autotoc_md1311}
(only in PRs)


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \mbox{\hyperlink{doc_dev_symbol-versioning_md}{Symbol versioning}} is correct for breaking changes
\item \mbox{[} \mbox{]} ABI/\+API changes are forward-\/compatible (breaking backwards-\/compatibility to add additional symbols is fine)
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1312}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_ksClear_md_autotoc_md1312}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function parameters should use enum types instead of boolean types wherever sensible
\item \mbox{[} \mbox{]} Wherever possible, function parameters should be {\ttfamily const}
\item \mbox{[} \mbox{]} Wherever possible, return types should be {\ttfamily const}
\item \mbox{[} \mbox{]} Functions should have the least amount of parameters feasible
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1313}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_ksClear_md_autotoc_md1313}

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

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[} \mbox{]} Documentation does not impose limits, that would hinder further extensions
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksClear_md_autotoc_md1316}{}\doxysubsection{Tests}\label{doc_api_review_core_ksClear_md_autotoc_md1316}

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