-
Notifications
You must be signed in to change notification settings - Fork 253
Description
Is your feature request related to a problem? Please describe.
The unit tests and API documentation should match, where all status codes in the API documentation are tested in a unit test, and likewise all codes being tested for are documented in the API.
Describe the solution you'd like
Resolve the following mismatches:
File src/os/inc/osapi-module.h, function OS_SymbolLookup():
- OK: OS_ERROR
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-module.h, function OS_ModuleSymbolLookup():
- OK: OS_ERROR
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-module.h, function OS_SymbolTableDump():
- ONLY IN DOXY: OS_ERROR
- ONLY IN DOXY: OS_ERR_NOT_IMPLEMENTED
- ONLY IN TEST: OS_FS_ERR_PATH_INVALID
- OK: OS_INVALID_POINTER
- ONLY IN DOXY: OS_SUCCESS
File src/os/inc/osapi-module.h, function OS_ModuleLoad():
- ONLY IN DOXY: OS_ERROR
- OK: OS_ERR_NAME_TAKEN
- ONLY IN DOXY: OS_ERR_NAME_TOO_LONG
- OK: OS_ERR_NO_FREE_IDS
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-module.h, function OS_ModuleUnload():
- ONLY IN DOXY: OS_ERROR
- ONLY IN TEST: OS_ERR_INVALID_ID
- OK: OS_SUCCESS
File src/os/inc/osapi-module.h, function OS_ModuleInfo():
- OK: OS_ERR_INVALID_ID
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
Additional context
Originally noted in #331, split into separate work items.
Requester Info
Joseph Hickey, Vantage Systems, Inc.