From 0c99d1fb566ad3071f25ea5f1ae94003c9a3a87c Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 20 Jan 2012 22:11:47 +0000 Subject: [PATCH] Fix documentation of wxConfig::Read(float*) overload. Grouping methods using "//@{" and "//@}" apparently doesn't work and completely wrong documentation is used in this case, so document the two overloads separately, as it's done for the other methods. Closes #13884. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70416 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/config.h | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/interface/wx/config.h b/interface/wx/config.h index 34b2c4263c..414397992b 100644 --- a/interface/wx/config.h +++ b/interface/wx/config.h @@ -596,8 +596,7 @@ public: /** Reads a float value, returning @true if the value was found. - With the second overload, if the value was not found, @a defaultVal is - used instead. + If the value was not found, @a f is not changed. Notice that the value is read as a double but must be in a valid range for floats for the function to return @true. @@ -608,13 +607,25 @@ public: Not supported by wxPerl. @endWxPerlOnly */ - //@{ bool Read(const wxString& key, float* f) const; + /** + Reads a float value, returning @true if the value was found. + + If the value was not found, @a defaultVal is used instead. + + Notice that the value is read as a double but must be in a valid range + for floats for the function to return @true. + + @since 2.9.1 + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly + */ bool Read(const wxString& key, float* f, float defaultVal) const; - //@} /** - Reads a float value, returning @true if the value was found. If the + Reads a boolean value, returning @true if the value was found. If the value was not found, @a b is not changed. @since 2.9.1 @@ -625,7 +636,7 @@ public: */ bool Read(const wxString& key, bool* b) const; /** - Reads a bool value, returning @true if the value was found. If the + Reads a boolean value, returning @true if the value was found. If the value was not found, @a defaultVal is used instead. @beginWxPerlOnly -- 2.45.2