\label{doc_api_review_core_keyGetValueSize_md_md_doc_api_review_core_keyGetValueSize}%
\Hypertarget{doc_api_review_core_keyGetValueSize_md_md_doc_api_review_core_keyGetValueSize}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/26 16\+:40
\item end = 2021-\/02-\/26 17\+:15
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\item reviewer = Robert Sowula
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetValueSize_md_autotoc_md961}{}\doxysection{Signature}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md961}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyvalue_gae326672fffb7474abfe9baf53b73217e}{key\+Get\+Value\+Size(const Key $\ast$key)}}}\hypertarget{doc_api_review_core_keyGetValueSize_md_autotoc_md962}{}\doxysection{Checklist}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md962}
\hypertarget{doc_api_review_core_keyGetValueSize_md_autotoc_md963}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md963}
(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{]} move below brief description
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Longer description of function containing common use cases
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} If the value is binary, there... ~\newline

\item \mbox{[} \mbox{]}\mbox{[}..\mbox{]} for binary data, so 0 will be returned. ~\newline

\item \mbox{[} \mbox{]} String types have it, so to there length will be added 1 to have enough space to store it. -\/$>$ Strings are null-\/terminated, and the null terminator will be considered for the length.
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add?
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add?
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add?
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} key\+: key -\/$>$ Key
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} 1\+: not binary -\/$>$ string ~\newline

\item \mbox{[} \mbox{]} 0\+: binary -\/$>$ not string (?)
\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{]} {\ttfamily \mbox{\hyperlink{group__keyvalue_ga41b9fac5ccddafe407fc0ae1e2eb8778}{key\+Get\+String()}}} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyvalue_ga4c0d8a4a11174197699c231e0b5c3c84}{key\+Get\+Binary()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetValueSize_md_autotoc_md964}{}\doxysubsection{Naming}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md964}

\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_api_review_core_keyGetValueSize_md_autotoc_md965}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md965}
(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_keyGetValueSize_md_autotoc_md966}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md966}

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

\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{]} swapped {\ttfamily with \mbox{\hyperlink{group__keyvalue_gae326672fffb7474abfe9baf53b73217e}{key\+Get\+Value\+Size()}}}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetValueSize_md_autotoc_md968}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md968}

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

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function code is fully covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Line 249
\end{DoxyItemize}
\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_api_review_core_keyGetValueSize_md_autotoc_md971}{}\doxysection{Summary}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md971}
\hypertarget{doc_api_review_core_keyGetValueSize_md_autotoc_md972}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyGetValueSize_md_autotoc_md972}
