
\begin{DoxyItemize}
\item start = 2021-\/02-\/26 11\+:15
\item end = 2021-\/02-\/26 12\+:15
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\item reviewer = Michael Tucek \href{mailto:michael@tucek.eu}{\texttt{ michael@tucek.\+eu}}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyUnescapedName_autotoc_md1261}{}\doxysection{Signature}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1261}
{\ttfamily const void $\ast$key\+Unescaped\+Name(const Key $\ast$key)}\hypertarget{md_doc_api_review_core_keyUnescapedName_autotoc_md1262}{}\doxysection{Checklist}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1262}
\hypertarget{md_doc_api_review_core_keyUnescapedName_autotoc_md1263}{}\doxysubsubsection{Doxygen}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1263}
(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{]} Merge first and second sentence ~\newline
 \textquotesingle{}Returns a key\textquotesingle{}s name where the key name parts are separated by null bytes and does not use backslash for escaping\textquotesingle{}
\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{[}x\mbox{]} Longer description of function containing common use cases
\item \mbox{[}x\mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

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

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

\item \mbox{[} \mbox{]} key stays unchanged ~\newline

\item \mbox{[} \mbox{]} returns pointer to unescaped Name
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

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

\item \mbox{[} \mbox{]} key stays unchanged
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}optional pointer to Key object\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} swap order ~\newline

\item \mbox{[} \mbox{]} \textquotesingle{}if Key has no name\textquotesingle{} ~\newline

\item \mbox{[} \mbox{]} \textquotesingle{}the Key\textquotesingle{}s name\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @ingroup} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @see} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \mbox{\hyperlink{group__keyname_ga44a576c7919d5b03f28d3ed3afaa7cd1}{key\+Get\+Unescaped\+Name()}} for getting a copy
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyUnescapedName_autotoc_md1264}{}\doxysubsection{Naming}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1264}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keyname_ga44a576c7919d5b03f28d3ed3afaa7cd1}{key\+Get\+Unescaped\+Name()}}} make difference to this function more clear?
\end{DoxyItemize}
\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_keyUnescapedName_autotoc_md1265}{}\doxysubsection{Compatibility}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1265}
(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_keyUnescapedName_autotoc_md1266}{}\doxysubsection{Parameter \& Return Types}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1266}

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

\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{]} mismatch, move up in docs to match place in header file
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyUnescapedName_autotoc_md1268}{}\doxysubsection{Memory Management}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1268}

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

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

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} no tests for this function
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} no tests for this function
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible enum values are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} no tests for this function
\end{DoxyItemize}
\item \mbox{[} \mbox{]} No inconsistencies between tests and documentation ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} no tests for this function
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyUnescapedName_autotoc_md1271}{}\doxysection{Summary}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1271}

\begin{DoxyItemize}
\item Why is return type void$\ast$ exactly?
\item include optional in key {\ttfamily @param} -\/ define schema for key param
\item Add explicit tests for this function
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyUnescapedName_autotoc_md1272}{}\doxysection{Other Issues discovered (unrelated to function)}\label{md_doc_api_review_core_keyUnescapedName_autotoc_md1272}

\begin{DoxyItemize}
\item Convention for keyX / key\+GetX (pointer vs copy) intended?
\item Remove elektra-\/internal functions
\item Functions are sorted alphabetically -\/ can we change this easily? 
\end{DoxyItemize}