Make code doc more readable

Co-authored-by: Julian Brost <julian.brost@icinga.com>
This commit is contained in:
Alexander Aleksandrovič Klimov 2021-01-27 15:43:37 +01:00 committed by GitHub
parent f04387a973
commit 8d1e958275
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -242,11 +242,11 @@ bool Checkable::NotificationReasonApplies(NotificationType type)
} }
/** /**
* Returns whether *this not allows sending a notification of type type right now. * Checks if notifications of a given type should be suppressed for this Checkable at the moment.
* *
* @param type The type of notification to send (or not to send). * @param type The notification type for which to query the suppression status.
* *
* @return Whether not to send the notification. * @return true if no notification of this type should be sent.
*/ */
bool Checkable::NotificationReasonSuppressed(NotificationType type) bool Checkable::NotificationReasonSuppressed(NotificationType type)
{ {