From 509f853757f0bc2812d1cd50ae6f1d6685e0578e Mon Sep 17 00:00:00 2001 From: Blake-Madden <66873089+Blake-Madden@users.noreply.github.com> Date: Mon, 22 Jan 2024 21:04:08 -0500 Subject: [PATCH] Add holiday authority overview Closes #24240. --- docs/doxygen/overviews/datetime.h | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/doxygen/overviews/datetime.h b/docs/doxygen/overviews/datetime.h index c612ebee5f..4881a5f0ce 100644 --- a/docs/doxygen/overviews/datetime.h +++ b/docs/doxygen/overviews/datetime.h @@ -201,9 +201,20 @@ these functions too, so they are subject to the same limitations. -@section overview_datetime_holidays wxDateTime and Holidays +@section overview_datetime_holidays Holidays -@todo WRITE THIS DOC PARAGRAPH. +The wxDateTimeHolidayAuthority-derived classes help determine whether a +given date is a holiday and are used by all functions working with "work days". +In this context, a holiday is an event which results in a day off from work. + +Multiple holiday authorities can be combined by passing them to +wxDateTimeHolidayAuthority::AddAuthority(), and a date can be verified as a holiday +by calling wxDateTimeHolidayAuthority::IsHoliday(). + +Holiday authorities are available for weekends (loaded by default) and +Catholic/Christian holy days of obligation. +Custom holiday authorities can also be created by deriving from wxDateTimeHolidayAuthority +and defining DoIsHoliday() and DoGetHolidaysInRange().