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.
This commit is contained in:
Ian McInerney
2021-05-13 03:19:35 +01:00
committed by Ian McInerney
parent 99bcb29fce
commit 1688429249
2 changed files with 3 additions and 5 deletions

View File

@@ -91,9 +91,6 @@ public:
Initial size. Initial size.
@param name @param name
Control name. Control name.
@return @true if the control was successfully created or @false if
creation failed.
*/ */
wxFileCtrl(wxWindow* parent, wxWindowID id, wxFileCtrl(wxWindow* parent, wxWindowID id,
@@ -107,6 +104,9 @@ public:
/** /**
Create function for two-step construction. See wxFileCtrl() for details. 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, bool Create(wxWindow* parent, wxWindowID id,
const wxString& defaultDirectory = wxEmptyString, const wxString& defaultDirectory = wxEmptyString,

View File

@@ -50,8 +50,6 @@ public:
The first of the range of IDs to unreserve. The first of the range of IDs to unreserve.
@param count @param count
The number of sequential IDs to unreserve. 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); static void UnreserveId(wxWindowID id, int count = 1);
}; };