From 6acc318f87980080a95b032156ef8d5f91fdc04c Mon Sep 17 00:00:00 2001 From: Simon Rozman Date: Wed, 2 Nov 2016 11:02:11 +0100 Subject: [PATCH] Documentation update --- include/WinStd/EAP.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/WinStd/EAP.h b/include/WinStd/EAP.h index a71fa2de..c055b061 100644 --- a/include/WinStd/EAP.h +++ b/include/WinStd/EAP.h @@ -408,7 +408,7 @@ namespace winstd /// /// \param[in] code EAP code (one of EapCode enum values) /// \param[in] id Packet ID - /// \param[in] size Initial packet size. Must be at least 4. + /// \param[in] size Total packet size in bytes, including header. Must be at least 4B. /// /// \note Packet data (beyond first 4B) is not initialized. /// @@ -418,7 +418,7 @@ namespace winstd /// inline bool create(_In_ EapCode code, _In_ BYTE id, _In_ WORD size) { - assert(size >= 4); // EAP packets must contain at least 4B. + assert(size >= 4); // EAP packets must contain at least Code, Id, and Length fields: 4B. handle_type h = (handle_type)HeapAlloc(GetProcessHeap(), 0, size); if (h) {