Document wxDateTime comparison operators behaviour

Mention that they intentionally can't be used with invalid objects except for
the exact comparison.
This commit is contained in:
Vadim Zeitlin 2016-04-12 20:51:09 +02:00
parent 56aa94c61e
commit 5e5d872150

View File

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