Signature
ssize_t keyAddName(Key *key, const char *addName)
Checklist
Doxygen
(bullet points are in order of appearance)
- First line explains briefly what the function does
- Add an already escaped key name part to the key name
- Simple example or snippet how to use the function
- add very simple example, with one simple key name part without dots
- Longer description of function containing common use cases
- add common use cases (append to a key name,..)
- Description of functions reads nicely
- passed name below brief description
- replace list with reference to canonicalization docs
- 'key name' rules no space before dot
@pre
- newName must be a valid name (reference to key name rules)
- move "It is not allowed to" precondition
@post
- newName has been added to key
@param
for every parameter
- key - pointer to Key object
- newName - name part to append to
key
's name
@return
/ @retval
- make error cases differentiable (key errors, name errors)?
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
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
- check if we can remove uncovered code
- All possible error states are covered by tests
- add test case for read-only key
- All possible enum values are covered by tests
- No inconsistencies between tests and documentation
Summary
Other Issues discovered (unrelated to function)
- What is a valid Key exactly? Or does it just mean a valid pointer?
- Different Return Vlaues for different errors
- Set Doxygen Options to sort after header file