Bad comment for return value of SntpGetTime_t

[machta]

The doc comment for SntpGetTime_t says "@return true if ...":

coreSNTP/source/include/core_sntp_client.h

Line 104 in 40d914a

* @return `true` if obtaining system time is successful; otherwise `false` to

But the function returns void:

coreSNTP/source/include/core_sntp_client.h

Line 107 in 40d914a

typedef void ( * SntpGetTime_t )( SntpTimestamp_t * pCurrentTime );

But it doesn't seem like a bad idea. Is there really no way to idicate failure from SntpGetTime_t or from SntpSetTime_t?

[kar-rahul-aws]

Hi @machta
Thank you for reporting the issue.
Yes, as you mentioned since both SntpGetTime_t and SntpSetTime_t internally call clock_gettime and clock_settime which have a return type , it is possible to define them as this

But since this will be a breaking change for the applications which use this library, we are removing the comment in this PR and will add this to our queue to improve later. You can also always contribute to the library ! We shall be happy to review it.

Thanks and Regards,
Rahul.