\label{doc_api_review_core_keyString_md_md_doc_api_review_core_keyString}%
\Hypertarget{doc_api_review_core_keyString_md_md_doc_api_review_core_keyString}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/26 16\+:05
\item end = 2021-\/02-\/26 16\+:40
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\item reviewer = Robert Sowula
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyString_md_autotoc_md1235}{}\doxysection{Signature}\label{doc_api_review_core_keyString_md_autotoc_md1235}
{\ttfamily const char $\ast$key\+String(const Key $\ast$key)}\hypertarget{doc_api_review_core_keyString_md_autotoc_md1236}{}\doxysection{Checklist}\label{doc_api_review_core_keyString_md_autotoc_md1236}
\hypertarget{doc_api_review_core_keyString_md_autotoc_md1237}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyString_md_autotoc_md1237}
(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{]} Get the pointer to the string representing the Key\textquotesingle{}s value.
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add example
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add explanation about pointers ~\newline

\item \mbox{[} \mbox{]} add explanation about modifications from the user
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily (null)} -\/$>$ {\ttfamily \char`\"{}(null)\char`\"{}} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily (binary)} -\/$>$ {\ttfamily \char`\"{}(binary)\char`\"{}}
\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{]} move before return ~\newline

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} pointer to the string representing the Key\textquotesingle{}s value ~\newline

\item \mbox{[} \mbox{]} {\ttfamily (null)} -\/$>$ {\ttfamily \char`\"{}(null)\char`\"{}} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily (binary)} -\/$>$ {\ttfamily \char`\"{}(binary)\char`\"{}}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add {\ttfamily 1.\+0.\+0}
\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()}}} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyvalue_ga6f29609c5da53c6dc26a98678d5752af}{key\+Value()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyString_md_autotoc_md1238}{}\doxysubsection{Naming}\label{doc_api_review_core_keyString_md_autotoc_md1238}

\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{[} \mbox{]} Function name should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyvalue_ga880936f2481d28e6e2acbe7486a21d05}{key\+String()}}} vs {\ttfamily \mbox{\hyperlink{group__keyvalue_ga41b9fac5ccddafe407fc0ae1e2eb8778}{key\+Get\+String()}}}
\end{DoxyItemize}
\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_keyString_md_autotoc_md1239}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyString_md_autotoc_md1239}
(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_keyString_md_autotoc_md1240}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyString_md_autotoc_md1240}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Functions should do exactly one thing ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Return Values (null) and (binary)
\end{DoxyItemize}
\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_keyString_md_autotoc_md1242}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyString_md_autotoc_md1242}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[} \mbox{]} Documentation does not impose limits, that would hinder further extensions ~\newline

\begin{DoxyItemize}
\item \char`\"{}(null)\char`\"{} \& \char`\"{}(binary)\char`\"{}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyString_md_autotoc_md1244}{}\doxysubsection{Tests}\label{doc_api_review_core_keyString_md_autotoc_md1244}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Line 198 ~\newline

\item \mbox{[}x\mbox{]} Line 203
\end{DoxyItemize}
\item 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_keyString_md_autotoc_md1245}{}\doxysection{Summary}\label{doc_api_review_core_keyString_md_autotoc_md1245}
Think about changing the return values for 1.\+0.\+0. It seems like a hard step, but also inevitable to do at some point. Now would probably be better than in the future.\hypertarget{doc_api_review_core_keyString_md_autotoc_md1246}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyString_md_autotoc_md1246}
