Document the meaning of empty value name in wxRegKey methods.

Empty value refers to the default or unnamed key in Win32 API but this may be
not clear to people unused to it so mention this explicitly.

Closes #11191.

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

diff --git a/interface/wx/msw/registry.h b/interface/wx/msw/registry.h
index cf1c200c7e5aef23d20c77a4b7875781c01d86a2..5fd4be294f949ff0575e98c870c72b4383fad42d 100644 (file)
--- a/interface/wx/msw/registry.h
+++ b/interface/wx/msw/registry.h
@@ -293,21 +293,25 @@ public:
 
     /**
         Retrieves the raw string value. Returns @true if successful.
 
     /**
         Retrieves the raw string value. Returns @true if successful.

+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryRawValue(const wxString& szValue, wxString& strValue) const;
 
     /**
         Retrieves the raw or expanded string value. Returns @true if successful.
     */
     bool QueryRawValue(const wxString& szValue, wxString& strValue) const;
 
     /**
         Retrieves the raw or expanded string value. Returns @true if successful.

+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;
 
     /**
         Retrieves the numeric value. Returns @true if successful.
     */
     bool QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;
 
     /**
         Retrieves the numeric value. Returns @true if successful.

+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryValue(const wxString& szValue, long* plValue) const;
 
     /**
         Retrieves the binary structure. Returns @true if successful.
     */
     bool QueryValue(const wxString& szValue, long* plValue) const;
 
     /**
         Retrieves the binary structure. Returns @true if successful.

+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;
 
     */
     bool QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;
 


@@ -349,16 +353,19 @@ public:
     /**
         Sets the given @a szValue which must be numeric. If the value doesn't
         exist, it is created. Returns @true if successful.
     /**
         Sets the given @a szValue which must be numeric. If the value doesn't
         exist, it is created. Returns @true if successful.

+        An empty @a szValue sets the default/unnamed key value.

     */
     bool SetValue(const wxString& szValue, long lValue);
     /**
         Sets the given @a szValue which must be string. If the value doesn't
         exist, it is created. Returns @true if successful.
     */
     bool SetValue(const wxString& szValue, long lValue);
     /**
         Sets the given @a szValue which must be string. If the value doesn't
         exist, it is created. Returns @true if successful.

+        An empty @a szValue sets the default/unnamed key value.

     */
     bool SetValue(const wxString& szValue, const wxString& strValue);
     /**
         Sets the given @a szValue which must be binary. If the value doesn't
         exist, it is created. Returns @true if successful.
     */
     bool SetValue(const wxString& szValue, const wxString& strValue);
     /**
         Sets the given @a szValue which must be binary. If the value doesn't
         exist, it is created. Returns @true if successful.

+        An empty @a szValue sets the default/unnamed key value.

     */
     bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
 };
     */
     bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
 };