diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h index 48b941b7b2..53595c78be 100644 --- a/interface/wx/datetime.h +++ b/interface/wx/datetime.h @@ -1161,11 +1161,15 @@ public: @a n may be either positive (counting from the beginning of the month) or negative (counting from the end of it). - For example, SetToWeekDay(2, wxDateTime::Wed) will set the date to the + For example, SetToWeekDay(wxDateTime::Wed, 2) will set the date to the second Wednesday in the current month and - SetToWeekDay(-1, wxDateTime::Sun) will set the date to the last Sunday + SetToWeekDay(wxDateTime::Sun, -1) will set the date to the last Sunday in the current month. + Note that leaving the month or year parameters as their default values + will result in the current month or year being substituted, overwriting + any previous values in the wxDateTime object. + @return @true if the date was modified successfully, @false otherwise meaning that the specified date doesn't exist. */