Function header documentation for OS_ObjectIdAllocateNew() is incorrect

[nohlson]

Describe the bug
The comments in the function header for OS_ObjectIdAllocateNew() is outdated/incorrect. I see that this was previously reported in #17 but it appears that since then the function signature and implementation has again changed.

osal/src/os/shared/src/osapi-idmap.c

Line 1169 in 88f72d7

* Inputs: last_alloc_id represents the previously issued ID of this type.

To Reproduce
N/A. Only in the function comments.

Expected behavior
Description of the function should be with the function prototype as described in #17. In this case the removal of the Inputs and Outputs sections of the function header.

Reporter Info
Nathan Ohlson

[skliper]

Agreed, many of function comments in osapi-idmap.c repeat, extend, or even occasionally contradict what's in os-shared-idmap.h. Should consolidate into os-shared-idmap.h and reference that documentation from osapi-idmap.c.