Signature
Key *keyNew(const char *keyname, ...)
Checklist
Doxygen
(bullet points are in order of appearance)
- First line explains briefly what the function does
- Simple example or snippet how to use the function
- Longer description of function containing common use cases
- is 0 a valid name? returns NULL if 0 is param
- Description of functions reads nicely
@pre
- Precondition
- name must be a valid key name
@post
- Postcondition
- returns a valid key object
@param
for every parameter
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
- it doesn't technically - but its a convenience function
- 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
- Docs say
Key *k = keyNew(0);
has same effect
as Key *k =keyNew("", KEY_END);
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
- Documentation says i can work with
Key *k =keyNew("", KEY_END);
Tests say
k = keyNew ("", KEY_END); succeed_if (k == NULL, "should be invalid"); keyDel (k);
- same as above with
keyNew(0)
Summary
Other Issues discovered (unrelated to function)