Update documentation

Signed-off-by: Simon Rozman <simon@rozman.si>
This commit is contained in:
Simon Rozman 2022-10-13 12:36:09 +02:00
parent 1f0b8cdb6d
commit 539828dd2c

View File

@ -684,12 +684,15 @@ namespace winstd
}
///
/// Tests if the object handle is INVAL.
/// Tests if the object handle is invalid.
///
/// \return
/// - Non zero when object handle is INVAL;
/// - Non zero when object handle is invalid;
/// - Zero otherwise.
///
/// \note Implementing `operator bool() const` would be correct C++ approach here. Unfortunately, it would produce ambiguities where `bool` and `handle_type` are polymorphed.
/// Use `!!` to test if the object handle is valid.
///
bool operator!() const
{
return m_h == invalid;