From b7e34d6ddeb428361513c9b9b88fa0291beeb7f3 Mon Sep 17 00:00:00 2001 From: "7u83@mail.ru" <7u83@mail.ru@noemail.net> Date: Sat, 5 Mar 2016 22:10:35 +0000 Subject: [PATCH] Added some comments. FossilOrigin-Name: 04f80317574a45bfd705dc38137f421eacc055ae76c51f9648f2ca46b27793fd --- src/cw/cw.h | 14 +++++++++++++- src/cw/lw.h | 4 ++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/src/cw/cw.h b/src/cw/cw.h index 9250514f..817ec953 100644 --- a/src/cw/cw.h +++ b/src/cw/cw.h @@ -16,7 +16,6 @@ */ - /* Use some macros from LWAPP */ /** @@ -43,9 +42,22 @@ */ #define cw_put_data lw_put_data +/** + * Put a bstr_t object + * see #lw_put_bstr + */ #define cw_put_bstr lw_put_bstr + +/** + * Put bstr16_t object + * see #lw_put_bstr16 + */ #define cw_put_bstr16 lw_put_bstr16 +/** + * Set dword + * see #lw_set_dword + */ #define cw_set_dword lw_set_dword #define cw_get_byte lw_get_byte diff --git a/src/cw/lw.h b/src/cw/lw.h index f3e61199..203a78ca 100644 --- a/src/cw/lw.h +++ b/src/cw/lw.h @@ -50,6 +50,10 @@ #define lw_set_word(dst,b) \ (*((uint16_t*)(dst)) = htons(w)) +/** + * Same as #lw_put_dword, but the return value + * is unspecified. + */ #define lw_set_dword(dst,dw)\ (*((uint32_t*)(dst)) = htonl(dw))