Improve wxDateTime::SetToWeekDay documentation.

See https://github.com/wxWidgets/wxWidgets/pull/1185
This commit is contained in:
Vadim Zeitlin 2019-01-27 03:41:22 +01:00
commit d8348b0419

View File

@ -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.
*/