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

diff --git a/interface/wx/config.h b/interface/wx/config.h
index 34b2c4263c0ed2898361ebc8e78149ea824ebb16..414397992b4038da53ce595219286f1fbedd79d8 100644 (file)
--- 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.
 
     /**
         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.
 
         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
     */
         Not supported by wxPerl.
         @endWxPerlOnly
     */

-    //@{

     bool Read(const wxString& key, float* f) const;
     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;
     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
         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;
     /**
     */
     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
         value was not found, @a defaultVal is used instead.
 
         @beginWxPerlOnly