Unit test status code discrepancies in osapi-timebase.h

[jphickey]

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:

NOTE: This API does not have a "unit-tests" program to test these status codes - Hence why they are all flagged as being only in doxygen. The "time-base-api-test" program does exercise many of them, but isn't included in this test run.

File src/os/inc/osapi-timebase.h, function OS_TimeBaseCreate():

• ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_STATE
• ONLY IN DOXY: OS_ERR_NAME_TOO_LONG
• ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-timebase.h, function OS_TimeBaseSet():

• ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_STATE
• ONLY IN DOXY: OS_TIMER_ERR_INVALID_ARGS

File src/os/inc/osapi-timebase.h, function OS_TimeBaseDelete():

• ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_STATE

File src/os/inc/osapi-timebase.h, function OS_TimeBaseGetIdByName():

• ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_STATE
• ONLY IN DOXY: OS_ERR_NAME_NOT_FOUND
• ONLY IN DOXY: OS_ERR_NAME_TOO_LONG
• ONLY IN DOXY: OS_INVALID_POINTER
• ONLY IN DOXY: OS_SUCCESS

File src/os/inc/osapi-timebase.h, function OS_TimeBaseGetInfo():

• ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_STATE
• ONLY IN DOXY: OS_ERR_INVALID_ID
• ONLY IN DOXY: OS_INVALID_POINTER
• ONLY IN DOXY: OS_SUCCESS

File src/os/inc/osapi-timebase.h, function OS_TimeBaseGetFreeRun():

• ONLY IN DOXY: OS_ERR_INVALID_ID
• ONLY IN DOXY: OS_INVALID_POINTER
• ONLY IN DOXY: OS_SUCCESS

Additional context
Originally noted in #331, split into separate work items.

Requester Info
Joseph Hickey, Vantage Systems, Inc.

[jphickey]

Plan is to add these functions into the "ostimer-test" unit-test to verify the return codes of these routines.

[jphickey]

Correction/Update - after closer consideration, since many of these return values are actually checked in the "time-base-api-test" program, preferable approach is to avoid unnecessary duplication. Will update the cross reference set to include these test cases, rather than duplicating many of them in "unit-tests".