document wxBase64DecodeMode and other minor fixes (closes #10882)

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

diff --git a/interface/wx/base64.h b/interface/wx/base64.h
index f59ea7ce8209de27af84ef30b6ee114766465af6..02c39d63339d9368c63b17e46d9b2d7c526a1ff8 100644 (file)
--- a/interface/wx/base64.h
+++ b/interface/wx/base64.h
@@ -14,6 +14,17 @@
 /** @addtogroup group_funcmacro_misc */
 //@{
 
+/** 
+    Elements of this enum specify the possible behaviours of wxBase64Decode
+    when an invalid character is encountered.
+*/
+enum wxBase64DecodeMode
+{
+    wxBase64DecodeMode_Strict,  ///< Normal behaviour: stop at any invalid characters.
+    wxBase64DecodeMode_SkipWS,  ///< Skip whitespace characters.
+    wxBase64DecodeMode_Relaxed  ///< The most lenient behaviour: simply ignore all invalid characters.
+};
+
 /**
     This function encodes the given data using base64.
 
@@ -133,7 +144,7 @@ size_t wxBase64Decode(void* dst, size_t dstLen,
                       size_t *posErr = NULL);
 
 /**
-    See the wxBase64Decode(void*,size_t,const char*,size_t,wxBase64DecodeMode,size_t)
+    See the wxBase64Decode(void*,size_t,const char*,size_t,wxBase64DecodeMode,size_t*)
     overload for more info about the parameters of this function.
 
     This overload allocates memory internally and returns it as wxMemoryBuffer
@@ -150,7 +161,7 @@ wxMemoryBuffer wxBase64Decode(const char* src,
                               size_t *posErr = NULL);
 
 /**
-    See the wxBase64Decode(void*,size_t,const char*,size_t,wxBase64DecodeMode,size_t)
+    See the wxBase64Decode(void*,size_t,const char*,size_t,wxBase64DecodeMode,size_t*)
     overload for more info about the parameters of this function.
 
     This overload takes as input a wxString and returns the internally-allocated