From 59b468845d10b47451b033d41d5a2e1387a4fb6e Mon Sep 17 00:00:00 2001 From: Andy Green Date: Sun, 24 Mar 2019 14:03:31 +0800 Subject: [PATCH] docs: correct lws_random doxygen docs 9 --- include/libwebsockets/lws-misc.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/include/libwebsockets/lws-misc.h b/include/libwebsockets/lws-misc.h index e58cad3a4..7ed1490dd 100644 --- a/include/libwebsockets/lws-misc.h +++ b/include/libwebsockets/lws-misc.h @@ -444,9 +444,8 @@ lws_timingsafe_bcmp(const void *a, const void *b, uint32_t len); * \param buf: buffer to fill * \param len: how much to fill * - * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if - * it's interested to see if the frame it's dealing with was sent in binary - * mode. + * Fills buf with len bytes of random. Returns the number of bytes set, if + * not equal to len, then getting the random failed. */ LWS_VISIBLE LWS_EXTERN int lws_get_random(struct lws_context *context, void *buf, int len);