Added documentation

nasa · Dec 17, 2023 · da66ce1 · da66ce1
1 parent 6a57d4f
commit da66ce1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/Fw/Types/Assert.cpp b/Fw/Types/Assert.cpp
@@ -165,6 +165,7 @@ namespace Fw {
         s_assertHook = this->previousHook;
     }
 
+    // Default handler of SwAssert functions
     NATIVE_INT_TYPE defaultSwAssert(
             FILE_NAME_ARG file,
             NATIVE_UINT_TYPE lineNo,

diff --git a/Fw/Types/Assert.hpp b/Fw/Types/Assert.hpp
@@ -7,9 +7,13 @@
     #define FW_ASSERT(...)
 #else // ASSERT is defined
 
+// Return only the first argument passed to the macro.
 #define FW_ASSERT_FIRST_ARG(ARG_0, ...) ARG_0
+// Return all the arguments of the macro, but the first one
 #define FW_ASSERT_NO_FIRST_ARG(ARG_0, ...) __VA_ARGS__
 
+// Passing the __LINE__ argument at the end of the function ensures that
+// the FW_ASSERT_NO_FIRST_ARG macro will never have an empty variadic variable
 #if FW_ASSERT_LEVEL == FW_FILEID_ASSERT
     #define FILE_NAME_ARG U32
     #define FW_ASSERT(...) \