optimize docs

This commit is contained in:
Robin Müller 2024-04-03 12:52:32 +02:00
parent 203c0bac5c
commit c5159fb645
Signed by: muellerr
GPG Key ID: A649FB78196E3849
3 changed files with 5 additions and 7 deletions

View File

@ -26,10 +26,8 @@ ReturnValue_t DeviceHandlerFailureIsolation::eventReceived(EventMessage* event)
if (isFdirInActionOrAreWeFaulty(event)) {
return returnvalue::OK;
}
// No FDIR reactions if we are in external control by default. If the user commands the device
// manually, this might be related to debugging to testing the device in a low-level way. FDIR
// reactions might get in the way of this process by restarting the device or putting it in
// the faulty state.
// As mentioned in the function documentation, no FDIR reaction are performed when the device
// is in external control.
if (owner->getHealth() == HasHealthIF::EXTERNAL_CONTROL) {
return returnvalue::OK;
}

View File

@ -46,8 +46,8 @@ class DeviceHandlerFailureIsolation : public FailureIsolationBase {
* It will perform recoveries or failures on a pre-defined set of events. If the user wants
* to add handling for custom events, this function should be overriden.
*
* It should be noted that this function will not perform FDIR reactions if the handler is
* faulty or in external control by default. If the user commands the device
* It should be noted that the default implementation will not perform FDIR reactions if the
* handler is faulty or in external control by default. If the user commands the device
* manually, this might be related to debugging to testing the device in a low-level way. FDIR
* reactions might get in the way of this process by restarting the device or putting it in
* the faulty state. If the user still requires FDIR handling in the EXTERNAL_CONTROL case,

View File

@ -53,4 +53,4 @@ class FailureIsolationBase : public ConfirmsFailuresIF, public HasParametersIF {
void doConfirmFault(EventMessage* event);
};
#endif /* FRAMEWORK_FDIR
#endif /* FRAMEWORK_FDIR */