\label{doc_contrib_api_reviews_core_keyRewindMeta_md_md_doc_contrib_api_reviews_core_keyRewindMeta}%
\Hypertarget{doc_contrib_api_reviews_core_keyRewindMeta_md_md_doc_contrib_api_reviews_core_keyRewindMeta}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/27 17\+:00
\item end = 2021-\/02-\/27 17\+:10
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1277}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1277}
{\ttfamily int key\+Rewind\+Meta(\+Key $\ast$key)}\hypertarget{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1278}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1278}
\hypertarget{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1279}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1279}
(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{]} first entry in meta-\/information
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move up a bit
\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{]} Use it -\/$>$ Use this function ~\newline

\item \mbox{[} \mbox{]} -\/then ~\newline

\item \mbox{[} \mbox{]} So you want -\/$>$ Afterwards, when you want to iterate the meta-\/information, you have ~\newline

\item \mbox{[} \mbox{]} to {\bfseries{use}} {\ttfamily \mbox{\hyperlink{group__keymeta_ga4c88342f580a4291455a801af71ce048}{key\+Next\+Meta()}}}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add \textquotesingle{}key must be a valid key\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add \textquotesingle{}key stays valid\textquotesingle{} ~\newline

\item \mbox{[}x\mbox{]} add \textquotesingle{}internal iterator set to first entry in metadata\textquotesingle{}
\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 whose internal iterator should be rewinded
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move success to normal {\ttfamily @return}
\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{]} split first line into two
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1280}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1280}

\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_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1281}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1281}
(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_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1282}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1282}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} 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_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1283}{}\doxysubsection{Structural Clarity}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1283}

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

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

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

\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{[}x\mbox{]} add test 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{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1287}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1287}
\hypertarget{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1288}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keyRewindMeta_md_autotoc_md1288}
