
\begin{DoxyItemize}
\item start = 2021-\/01-\/23 18\+:10
\item end = 2021-\/01-\/23 18\+:10
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\tt stefanhani@gmail.\+com}
\end{DoxyItemize}

{\ttfamily int \hyperlink{group__kdb_ga11436b058408f83d303ca5e996832bcf}{kdb\+Set(\+K\+D\+B $\ast$handle, Key\+Set $\ast$returned, Key $\ast$parent\+Key)}}

(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} First line explains briefly what the function does
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function
\item \mbox{[} \mbox{]} Longer description of function containing common use cases
\item \mbox{[} \mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre}
\item \mbox{[} \mbox{]} {\ttfamily @post}
\item \mbox{[} \mbox{]} {\ttfamily @invariant}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\item \mbox{[} \mbox{]} {\ttfamily @since}
\item \mbox{[} \mbox{]} `{\ttfamily }
\item {\ttfamily \mbox{[} \mbox{]}}\begin{DoxySeeAlso}{See also}
`
\end{DoxySeeAlso}

\end{DoxyItemize}


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Abbreviations used in function names must be defined in the \hyperlink{doc_help_elektra-glossary_md}{Glossary}
\item \mbox{[} \mbox{]} Function names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Function name should be clear and unambiguous
\item \mbox{[} \mbox{]} Abbreviations used in parameter names must be defined in the \hyperlink{doc_help_elektra-glossary_md}{Glossary}
\item \mbox{[} \mbox{]} Parameter names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}

(only in P\+Rs)


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \hyperlink{doc_dev_symbol-versioning_md}{Symbol versioning} is correct for breaking changes
\item \mbox{[} \mbox{]} A\+B\+I/\+A\+PI changes are forward-\/compatible (breaking backwards-\/compatibility to add additional symbols is fine)
\end{DoxyItemize}


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function parameters should use enum types instead of boolean types wherever sensible
\item \mbox{[} \mbox{]} Wherever possible, function parameters should be {\ttfamily const}
\item \mbox{[} \mbox{]} Wherever possible, return types should be {\ttfamily const}
\item \mbox{[} \mbox{]} Functions should have the least amount of parameters feasible
\end{DoxyItemize}


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Functions should do exactly one thing
\item \mbox{[} \mbox{]} Function name has the appropriate prefix
\item \mbox{[} \mbox{]} Order of signatures in kdb.\+h.\+in is the same as Doxygen
\item \mbox{[} \mbox{]} No functions with similar purpose exist
\end{DoxyItemize}


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Memory Management should be handled by the function wherever possible
\end{DoxyItemize}


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


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function code is fully covered by tests
\item \mbox{[} \mbox{]} All possible error states are covered by tests
\item \mbox{[} \mbox{]} All possible enum values are covered by tests
\item \mbox{[} \mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}