From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 19 May 2010 21:03:49 +0000 (+0000)
Subject: Document that wxWindow::FindWindowByXXX() functions may return NULL.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/d9c83ba8290fb6b0b342d4c5d4d2834511a73066

Document that wxWindow::FindWindowByXXX() functions may return NULL.

This seems obvious but apparently isn't completely so to everybody.

Closes #12074.

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 4ac6a5b0a3..548752f7c9 100644
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -3172,6 +3172,8 @@ public:
         The search is recursive in both cases.
 
         @see FindWindow()
+
+        @return Window with the given @a id or @NULL if not found.
     */
     static wxWindow* FindWindowById(long id, const wxWindow* parent = 0);
 
@@ -3185,6 +3187,8 @@ public:
         The search is recursive in both cases.
 
         @see FindWindow()
+
+        @return Window with the given @a label or @NULL if not found.
     */
     static wxWindow* FindWindowByLabel(const wxString& label,
                                        const wxWindow* parent = 0);
@@ -3201,6 +3205,8 @@ public:
         FindWindowByLabel() is called.
 
         @see FindWindow()
+
+        @return Window with the given @a name or @NULL if not found.
     */
     static wxWindow* FindWindowByName(const wxString& name,
                                       const wxWindow* parent = 0);