Merge pull request #1029 from jphickey/fix-1009-clock-retcodes

Fix #1009, add missing clock retcode tests
nasa · Jun 1, 2021 · b6511e9 · b6511e9
2 parents d5c8fc4 + 78e87f7
commit b6511e9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/os/inc/osapi-clock.h b/src/os/inc/osapi-clock.h
@@ -80,9 +80,10 @@ enum
  *
  * @note Mission time management typically uses the cFE Time Service
  *
- * @param[out]  time_struct An OS_time_t that will be set to the current time
+ * @param[out]  time_struct An OS_time_t that will be set to the current time @nonnull
  *
  * @return Get local time status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS @copybrief OS_SUCCESS
  * @retval #OS_INVALID_POINTER if time_struct is null
  */
 int32 OS_GetLocalTime(OS_time_t *time_struct);
@@ -95,9 +96,10 @@ int32 OS_GetLocalTime(OS_time_t *time_struct);
  *
  * @note Mission time management typically uses the cFE Time Services
  *
- * @param[in]  time_struct An OS_time_t containing the current time
+ * @param[in]  time_struct An OS_time_t containing the current time @nonnull
  *
  * @return Set local time status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS @copybrief OS_SUCCESS
  * @retval #OS_INVALID_POINTER if time_struct is null
  */
 int32 OS_SetLocalTime(const OS_time_t *time_struct);

diff --git a/src/unit-tests/oscore-test/ut_oscore_misc_test.c b/src/unit-tests/oscore-test/ut_oscore_misc_test.c
@@ -295,7 +295,7 @@ void UT_os_setlocaltime_test()
     /*-----------------------------------------------------*/
     /* #1 Null-pointer-arg */
 
-    UT_RETVAL(OS_GetLocalTime(NULL), OS_INVALID_POINTER);
+    UT_RETVAL(OS_SetLocalTime(NULL), OS_INVALID_POINTER);
 
     /*-----------------------------------------------------*/
     /* #3 Nominal */