NK_DTOA needs more documentation #699
Description
The current documentation states:
You can define this to dtoa or your own double to string conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!).
The problem is, there is no such function. dtoa is neither in C standard library, C++ standard library or in POSIX. I just don't know what is the "contract" of this function.
Based on Nuklear's code:
The function takes a buffer and a value of type double and returns the end of the string in the buffer.
How large the buffer should be? I checked the implementation and found out it is NK_MAX_NUMBER_BUFFER. This constant is documented but it is easy to lose it - NK_DTOA does not mention it and does not even specify how the function should look like (and there is no standard function to look into).
IMO it should be documented that:
NK_DTOArelies onNK_MAX_NUMBER_BUFFER- what the expected function prototype is
- what the expected behavior is (e.g. returns start or end of buffer)