diff --git a/inc/macros.hpp b/inc/macros.hpp index 25a0833b069d95c291b668d7bb2d7eb93d4f79b9..db57516f3ac7802c4200d4088163cff1b8d76dc8 100644 --- a/inc/macros.hpp +++ b/inc/macros.hpp @@ -1,7 +1,18 @@ #ifndef ECSS_SERVICES_MACROS_HPP #define ECSS_SERVICES_MACROS_HPP +/** + * Perform an assertion that, if failed, throws an ErrorHandler::Internal error + * + * @todo Actually hold program execution or throw an exception here + */ #define assertI(cond, error) (ErrorHandler::assertInternal((cond), (error))) + +/** + * A wrapper for ErrorHandler::assertRequest() that uses `this` as the Message object. + * + * Only to be used within the Message class. + */ #define assertR(cond, error) (ErrorHandler::assertRequest((cond), *this, (error))) #endif //ECSS_SERVICES_MACROS_HPP