Forum Discussion
Minor Documentation Bugs in OVR_CAPI.h
Thank you Oculus for creating the wonderful documentation comments in the header file OVR_CAPI.h
In particular, the structured comments for function arguments,
e.g. "/// \param[in] session Specifies an ovrSession previously returned by ovr_Create."
greatly simplify the task of generating python bindings for the Oculus Rift SDK. Especially compared to certain other virtual reality APIs I could name...
But there are a couple of cases where the parameter name in the structured comment does not exactly match the parameter name in the function signature. It would make my life easier if these parameter names could be made to match please.
1) At lines 1297 and 1315 in OVR_CAPI.h, the final argument to ovr_Create(...) is variously named "luid" and "pLuid". I think line 1297 should be modified to read:
"/// \param[out] pLuid Provides a system specific graphics adapter identifier that locates which"
2) At lines 1612 and 1618 in OVR_CAPI.h, the final argument to ovr_GetBoundaryDimensions(...) is variously named "dimensions" and "outDimensions". These should probably both read "outDimensions".
In particular, the structured comments for function arguments,
e.g. "/// \param[in] session Specifies an ovrSession previously returned by ovr_Create."
greatly simplify the task of generating python bindings for the Oculus Rift SDK. Especially compared to certain other virtual reality APIs I could name...
But there are a couple of cases where the parameter name in the structured comment does not exactly match the parameter name in the function signature. It would make my life easier if these parameter names could be made to match please.
1) At lines 1297 and 1315 in OVR_CAPI.h, the final argument to ovr_Create(...) is variously named "luid" and "pLuid". I think line 1297 should be modified to read:
"/// \param[out] pLuid Provides a system specific graphics adapter identifier that locates which"
2) At lines 1612 and 1618 in OVR_CAPI.h, the final argument to ovr_GetBoundaryDimensions(...) is variously named "dimensions" and "outDimensions". These should probably both read "outDimensions".
4 Replies
- Thank you mconte.
mconte said:
Looks like typos as a result of a refactor. Thanks for the report, we will make these changes. - Thank you for fixing this up in SDK 1.10! This should allow me to use fewer hacks when generating the python bindings at https://github.com/cmbruns/pyovr
- Another documentation bug I just ran into is found in the ovr_capi_d3d.h header, function ovr_CreateTextureSwapChainDX.
The function signature no longer includes the bindFlags parameter, which the documentation is describing.
