ssize_t keyGetBaseName(const Key *key, char *returned, size_t maxSize)
(bullet points are in order of appearance)
- [x] 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
- [ ] add description of what happens when maxSize < baseNameSize
- [x] Description of functions reads nicely
- [ ]
@pre
- [ ]
@post
- [ ]
@invariant
- [x]
@param
for every parameter
- [x]
@return
/ @retval
- [ ]
@since
- [x] `
[ ]
- See also
- `
- [ ] split first line
- [ ] maybe remove second line?
- Abbreviations used in function names must be defined in the Glossary
- [x] Function names should neither be too long, nor too short
- [x] Function name should be clear and unambiguous
- Abbreviations used in parameter names must be defined in the Glossary
- [x] Parameter names should neither be too long, nor too short
- [ ] Parameter names should be clear and unambiguous
- [ ] change to returnedBaseName in order to be more in line with other functions?
(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)
- Function parameters should use enum types instead of boolean types wherever sensible
- [x] Wherever possible, function parameters should be
const
- [x] Wherever possible, return types should be
const
- [x] Functions should have the least amount of parameters feasible
- [x] Functions should do exactly one thing
- [x] Function name has the appropriate prefix
- [x] Order of signatures in kdb.h.in is the same as Doxygen
- [x] No functions with similar purpose exist
- [x] Memory Management should be handled by the function wherever possible
- [x] Function is easily extensible, e.g., with flags
- [x] Documentation does not impose limits, that would hinder further extensions
- [ ] Function code is fully covered by tests
- [ ] All possible error states are covered by tests
- All possible enum values are covered by tests
- [x] No inconsistencies between tests and documentation
add more tests for special cases? (spaces, escaped slashes,...)