From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Thu, 14 Jan 2010 22:43:23 +0000 (+0000)
Subject: Minor corrections to wxFlexGridSizer ctor documentation.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/b4c1fe36b9854cdb404906ba3a181a67f9247e0e

Minor corrections to wxFlexGridSizer ctor documentation.

Be more clear about what does it mean to specify the number of rows. Don't use
@code for inline expressions. Remove an extraneous "it".

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

diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h
index 36a866fd12..0959477a4b 100644
--- a/interface/wx/sizer.h
+++ b/interface/wx/sizer.h
@@ -1463,9 +1463,13 @@ public:
         Usually only the number of columns in the flex grid sizer needs to be
         specified using @a cols argument. The number of rows will be deduced
         automatically depending on the number of the elements added to the
-        sizer. If the number of @a rows is explicitly specified (and not zero),
-        the sizer will check that it no more than @code cols*rows @endcode
-        elements are added to it.
+        sizer.
+
+        If a constructor form with @a rows parameter is used (and the value of
+        @a rows argument is not zero, meaning "unspecified") the sizer will
+        check that no more than @c cols*rows elements are added to it, i.e.
+        that no more than the given number of @a rows is used. Adding less than
+        maximally allowed number of items is not an error however.
 
         The @a gap (or @a vgap and @a hgap, which correspond to the height and
         width of the wxSize object) argument defines the size of the padding