Elektra 0.11.0
keyClear

Signature

int keyClear(Key *key)

Checklist

Doxygen

(bullet points are in order of appearance)

  • First line explains briefly what the function does
    • remove first line, second line could be improved a bit
      (what is meant with internal data, exactly? is the name included?)
  • Simple example or snippet how to use the function
  • Longer description of function containing common use cases
    • be more explicit which data is actually included
  • Description of functions reads nicely
    • very short sentences
  • @pre
    • Precondition
      key is a valid key
  • @post
    • Postcondition
      key contains not internal data
  • @invariant
    • Invariant
      key stays a valid key
  • @param for every parameter
  • @return / @retval
    • mark default case with @return
  • @since
    • add

Naming

  • Abbreviations used in function names must be defined in the 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
    • new keyCopy can also clear a key, maybe make keyClear an alias?

Memory Management

  • Memory Management should be handled by the function wherever possible

Extensibility

  • Function is easily extensible, e.g., with flags
    • could add flags for clearing parts of the key like keyCopy()
  • Documentation does not impose limits, that would hinder further extensions

Tests

  • Function code is fully covered by tests
  • All possible error states are covered by tests
  • All possible enum values are covered by tests
  • No inconsistencies between tests and documentation

Summary

Other Issues discovered (unrelated to function)