From 5e5d8721504c05b275a26bfee093aefd22242b81 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 12 Apr 2016 20:51:09 +0200 Subject: [PATCH] Document wxDateTime comparison operators behaviour Mention that they intentionally can't be used with invalid objects except for the exact comparison. --- interface/wx/datetime.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h index e8349bb094..82624aa87b 100644 --- a/interface/wx/datetime.h +++ b/interface/wx/datetime.h @@ -645,7 +645,14 @@ public: @name Date Comparison There are several functions to allow date comparison. To supplement - them, a few global operators, etc taking wxDateTime are defined. + them, the usual comparison operators taking wxDateTime are defined as + well. + + Notice that an invalid wxDateTime object can only be compared for + exact equality, i.e. using @c operator==(), @c operator!=() or + IsEqualTo(), but comparisons involving an invalid wxDateTime object + using any other operators or IsEarlierThan() or IsLaterThan() functions + would result in an assert because their result is not well-defined. */ //@{