From 16884292498d290ed098f12bf58dbe16f13b0772 Mon Sep 17 00:00:00 2001 From: Ian McInerney Date: Thu, 13 May 2021 03:19:35 +0100 Subject: [PATCH] Ensure the return documentation is on the correct function UnreserveId doesn't return anything, and the documentation for the boolean return in wxFileDialog should be on Create not the constructor. --- interface/wx/filectrl.h | 6 +++--- interface/wx/windowid.h | 2 -- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/interface/wx/filectrl.h b/interface/wx/filectrl.h index 364fbf7117..5e8be8e802 100644 --- a/interface/wx/filectrl.h +++ b/interface/wx/filectrl.h @@ -91,9 +91,6 @@ public: Initial size. @param name Control name. - - @return @true if the control was successfully created or @false if - creation failed. */ wxFileCtrl(wxWindow* parent, wxWindowID id, @@ -107,6 +104,9 @@ public: /** Create function for two-step construction. See wxFileCtrl() for details. + + @return @true if the control was successfully created or @false if + creation failed. */ bool Create(wxWindow* parent, wxWindowID id, const wxString& defaultDirectory = wxEmptyString, diff --git a/interface/wx/windowid.h b/interface/wx/windowid.h index 024e10c690..8bb924524c 100644 --- a/interface/wx/windowid.h +++ b/interface/wx/windowid.h @@ -50,8 +50,6 @@ public: The first of the range of IDs to unreserve. @param count The number of sequential IDs to unreserve. - - @return The value of the first ID in the sequence, or wxID_NONE. */ static void UnreserveId(wxWindowID id, int count = 1); };