Elektra 0.11.0
keyDup

Signature

Key *keyDup(const Key *source)

Checklist

Doxygen

(bullet points are in order of appearance)

  • First line explains briefly what the function does
    • could be a bit more specific
  • Simple example or snippet how to use the function
    • remove the wrapping function as it only distracts
  • Longer description of function containing common use cases
    • be a bit more explicit
  • Description of functions reads nicely
    • "Like for a new key" could be formulated better
  • @pre
    • Precondition
      source must be a valid key
  • @post
    • Postcondition
      returns a full copy of the key including all info (metadata, ..)
  • @invariant
    • Invariant
      source stays a valid key
  • @param for every parameter
  • @return / @retval
  • @since
    • add

Naming

  • Abbreviations used in function names must be defined in the Glossary
    • add dup to glossary
  • Function names should neither be too long, nor too short
  • Function name should be clear and unambiguous
  • Abbreviations used in parameter names must be defined in the Glossary
  • Parameter names should neither be too long, nor too short
  • Parameter names should be clear and unambiguous

Compatibility

(only in PRs)

  • Symbol versioning is correct for breaking changes
  • ABI/API changes are forward-compatible (breaking backwards-compatibility to add additional symbols is fine)

Parameter & Return Types

  • Function parameters should use enum types instead of boolean types wherever sensible
  • Wherever possible, function parameters should be const
  • Wherever possible, return types should be const
  • Functions should have the least amount of parameters feasible

Structural Clarity

  • Functions should do exactly one thing
  • Function name has the appropriate prefix
  • Order of signatures in kdb.h.in is the same as Doxygen
  • No functions with similar purpose exist

Memory Management

  • Memory Management should be handled by the function wherever possible

Extensibility

  • Function is easily extensible, e.g., with flags
  • Documentation does not impose limits, that would hinder further extensions

Tests

  • Function code is fully covered by tests
    • Error state is hard to check, cause it only appears on null pointers which gets checked in the function itself already
  • All possible error states are covered by tests
    • see above
  • All possible enum values are covered by tests
  • No inconsistencies between tests and documentation

Summary

Other Issues discovered (unrelated to function)