From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sat, 1 Dec 2012 00:13:40 +0000 (+0000)
Subject: Fix documentation of wxGridBagSizer::Add() spacer overload.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/faadbe6f398d4742f3677dde8d37e7308a384d31

Fix documentation of wxGridBagSizer::Add() spacer overload.

Describe the width and height parameters.

See #14866.

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

diff --git a/interface/wx/gbsizer.h b/interface/wx/gbsizer.h
index f1604bbc9e..39a7d6ac94 100644
--- a/interface/wx/gbsizer.h
+++ b/interface/wx/gbsizer.h
@@ -93,12 +93,20 @@ public:
     wxSizerItem* Add(wxSizer* sizer, const wxGBPosition& pos,
                      const wxGBSpan& span = wxDefaultSpan,
                      int flag = 0, int border = 0, wxObject* userData = NULL);
+    wxSizerItem* Add(wxGBSizerItem* item);
+
+    /**
+        Adds a spacer to the given position.
+        @a width and @a height specify the dimension of the spacer to be added.
+
+        @return A valid pointer if the spacer was successfully placed at the
+                 given position, or @NULL if something was already there.
+    */
     wxSizerItem* Add(int width, int height, const wxGBPosition& pos,
                      const wxGBSpan& span = wxDefaultSpan,
                      int flag = 0, int border = 0, wxObject* userData = NULL);
-    wxSizerItem* Add(wxGBSizerItem* item);
-    //@}
 
+    //@}
     /**
         Called when the managed size of the sizer is needed or when layout
         needs done.