From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 29 Mar 2009 21:31:40 +0000 (+0000)
Subject: make it explicitly clear that the len parameter of SetData() is in bytes
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/d21aa7f4eb15c7b92a7107b3e24beaa0d618cf84

make it explicitly clear that the len parameter of SetData() is in bytes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59934 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/dataobj.h b/interface/wx/dataobj.h
index 7ef7587d87..6f3951a0d3 100644
--- a/interface/wx/dataobj.h
+++ b/interface/wx/dataobj.h
@@ -277,7 +277,14 @@ public:
         Set the data in the format @a format of the length @a len provided in
         the buffer @a buf.
 
-        @return @true on success, @false on failure.
+        @param format
+            The format for which to set the data.
+        @param len
+            The size of data in bytes.
+        @param buf
+            Non-@NULL pointer to the data.
+        @return
+            @true on success, @false on failure.
     */
     virtual bool SetData(const wxDataFormat& format, size_t len, const void* buf);