\label{doc_api_review_core_keyNextMeta_md_md_doc_api_review_core_keyNextMeta}%
\Hypertarget{doc_api_review_core_keyNextMeta_md_md_doc_api_review_core_keyNextMeta}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/27 17\+:10
\item end = 2021-\/02-\/27 17\+:20
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyNextMeta_md_autotoc_md1112}{}\doxysection{Signature}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1112}
{\ttfamily const Key $\ast$key\+Next\+Meta(Key $\ast$key)}\hypertarget{doc_api_review_core_keyNextMeta_md_autotoc_md1113}{}\doxysection{Checklist}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1113}
\hypertarget{doc_api_review_core_keyNextMeta_md_autotoc_md1114}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1114}
(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{]} \textquotesingle{}Sets internal iterator to the next meta-\/information entry\textquotesingle{}
\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{[}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 \textquotesingle{}key is a valid key\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add \textquotesingle{}internal iterator set to next meta-\/information entry\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add \textquotesingle{}key stays valid\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @param} for every parameter
\item \mbox{[}x\mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\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__keymeta_ga5dbb669802eea27e106ee3a5e39717a9}{key\+Rewind\+Meta()}}} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__keymeta_ga74a273f529030f4947df52e14fdd2869}{key\+Current\+Meta()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyNextMeta_md_autotoc_md1115}{}\doxysubsection{Naming}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1115}

\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_keyNextMeta_md_autotoc_md1116}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1116}
(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_keyNextMeta_md_autotoc_md1117}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1117}

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

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

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

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

\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 check 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_api_review_core_keyNextMeta_md_autotoc_md1122}{}\doxysection{Summary}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1122}
\hypertarget{doc_api_review_core_keyNextMeta_md_autotoc_md1123}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyNextMeta_md_autotoc_md1123}
