Mention that wxSizer::Clear() always deletes child sizers.

The existence of "delete_windows" argument could mislead people into thinking
that sizers were not deleted neither when it had false value, see #15475.

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

diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h
index e4dde3e69419e2692286a695d2dd4b8b8002182f..6eafc589464315be72249eb3d2e9d9d8b7558085 100644 (file)
--- a/interface/wx/sizer.h
+++ b/interface/wx/sizer.h
@@ -326,7 +326,13 @@ public:
 
     /**
         Detaches all children from the sizer.
+
         If @a delete_windows is @true then child windows will also be deleted.
+
+        Notice that child sizers are always deleted, as a general consequence
+        of the principle that sizers own their sizer children, but don't own
+        their window children (because they are already owned by their parent
+        windows).
     */
     virtual void Clear(bool delete_windows = false);