
\begin{DoxyItemize}
\item start = 2021-\/02-\/22 13\+:10
\item end = 2021-\/02-\/22 13\+:40
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\item reviewer = Philipp Gackstatter
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyGetNameSize_autotoc_md910}{}\doxysection{Signature}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md910}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyname_gabdbcfa51ed8a387e47ead207affa2d2e}{key\+Get\+Name\+Size(const Key $\ast$key)}}}\hypertarget{md_doc_api_review_core_keyGetNameSize_autotoc_md911}{}\doxysection{Checklist}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md911}
\hypertarget{md_doc_api_review_core_keyGetNameSize_autotoc_md912}{}\doxysubsubsection{Doxygen}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md912}
(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{]} only describes return value ~\newline

\item \mbox{[} \mbox{]} null-\/termination ~\newline

\item \mbox{[} \mbox{]} mit return mergen
\end{DoxyItemize}
\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{]} better describe common use case ~\newline

\item \mbox{[} \mbox{]} example for error case ~\newline

\item \mbox{[} \mbox{]} example for empty string
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add \textquotesingle{}Key should be valid\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add \textquotesingle{}key doesn\textquotesingle{}t get modified\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add \textquotesingle{}key doesn\textquotesingle{}t get modified\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}key object to get the size of the name from\textquotesingle{} ~\newline

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} without owner?
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @see} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add parentheses to key\+Get\+Unescaped\+Name\+Size
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyGetNameSize_autotoc_md913}{}\doxysubsection{Naming}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md913}

\begin{DoxyItemize}
\item Abbreviations used in function names must be defined in the 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 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{md_doc_api_review_core_keyGetNameSize_autotoc_md914}{}\doxysubsection{Compatibility}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md914}
(only in PRs)


\begin{DoxyItemize}
\item 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{md_doc_api_review_core_keyGetNameSize_autotoc_md915}{}\doxysubsection{Parameter \& Return Types}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md915}

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

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

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

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

\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{[} \mbox{]} add test case for 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{md_doc_api_review_core_keyGetNameSize_autotoc_md920}{}\doxysection{Summary}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md920}
try splitting ifs to two lines, for better coverage reports\hypertarget{md_doc_api_review_core_keyGetNameSize_autotoc_md921}{}\doxysection{Other Issues discovered (unrelated to function)}\label{md_doc_api_review_core_keyGetNameSize_autotoc_md921}
