Merge pull request #2061 from nasa/integration-candidate

cFE Integration candidate: Caelum-rc4+dev4
nasa · Feb 25, 2022 · 1d3e4cd · 1d3e4cd
2 parents 99429bf + e48c049
commit 1d3e4cd
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 7 deletions.
diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml
@@ -60,6 +60,7 @@ jobs:
       - name: Build Docs
         run: |
           make doc > make_doc_stdout.txt 2> make_doc_stderr.txt
+          mv build/docs/detaildesign-warnings.log detaildesign-warnings.log
 
       # Upload documentation logs as artifacts
       - name: Archive Documentation Build Logs
@@ -69,6 +70,7 @@ jobs:
           path: |
             make_doc_stdout.txt
             make_doc_stderr.txt
+            detaildesign-warnings.log
 
       - name: Error Check
         run: |
@@ -77,6 +79,13 @@ jobs:
             exit -1
           fi
 
+      - name: Warning Check
+        run: |
+          if [[ -s detaildesign-warnings.log ]]; then
+            cat detaildesign-warnings.log
+            exit -1
+          fi
+
   build-usersguide:
     #Continue if check-for-duplicates found no duplicates. Always runs for pull-requests.
     needs: check-for-duplicates

diff --git a/README.md b/README.md
@@ -10,6 +10,14 @@ The detailed cFE user's guide can be viewed at <https://github.com/nasa/cFS/blob
 
 ## Changelog
 
+### Development Build: v7.0.0-rc4+dev80
+
+- Missing SB include for v2 msgid
+- Resolve doxygen doc warnings and enforce in CI
+- Remove explicit filename doxygen comments
+- Add CFE_ES_CreateChildTask default handler
+- See <https://github.com/nasa/cFE/pull/2061> and <https://github.com/nasa/cFS/pull/432>
+
 ### Development Build: v7.0.0-rc4+dev70
 
 - Improve CFE_SB_IsValidMsgId handler

diff --git a/cmake/cfe-common.doxyfile.in b/cmake/cfe-common.doxyfile.in
@@ -80,6 +80,10 @@ EXCLUDE_PATTERNS       += "*/ut-stubs/*"
 EXCLUDE_PATTERNS       += "*/ut-coverage/*"
 EXCLUDE_PATTERNS       += "*/unit-test*/*"
 
+# Exclude contributing guides and readme's since they stand alone as repo documentation
+EXCLUDE_PATTERNS       += "*/CONTRIBUTING.md"
+EXCLUDE_PATTERNS       += "*/README.md"
+
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
 #---------------------------------------------------------------------------

diff --git a/cmake/target/src/target_config.c b/cmake/target/src/target_config.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * \file target_config.c
+ * \file
  *
  *  Created on: Dec 3, 2013
  *  Created by: joseph.p.hickey@nasa.gov

diff --git a/modules/core_api/fsw/inc/cfe_version.h b/modules/core_api/fsw/inc/cfe_version.h
@@ -28,7 +28,7 @@
 #define CFE_VERSION_H
 
 /* Development Build Macro Definitions */
-#define CFE_BUILD_NUMBER   70           /**< @brief Development: Number of development commits since baseline */
+#define CFE_BUILD_NUMBER   80           /**< @brief Development: Number of development commits since baseline */
 #define CFE_BUILD_BASELINE "v7.0.0-rc4" /**< @brief Development: Reference git tag for build number */
 
 /* Version Macro Definitions updated for official releases only */

diff --git a/modules/core_api/ut-stubs/src/cfe_es_handlers.c b/modules/core_api/ut-stubs/src/cfe_es_handlers.c
@@ -116,6 +116,40 @@ static const cpuaddr UT_ESPOOL_ALIGN_MASK = ((cpuaddr) & ((struct UT_AlignTest *
 ** Functions
 */
 
+/*------------------------------------------------------------
+ *
+ * Default handler for CFE_ES_CreateChildTask coverage stub function
+ *
+ *------------------------------------------------------------*/
+void UT_DefaultHandler_CFE_ES_CreateChildTask(void *UserObj, UT_EntryKey_t FuncKey, const UT_StubContext_t *Context)
+{
+    CFE_ES_TaskId_t *TaskIdPtr = UT_Hook_GetArgValueByName(Context, "TaskIdPtr", CFE_ES_TaskId_t *);
+    int32            status;
+    void *           IdBuff;
+    size_t           BuffSize;
+    size_t           Position;
+
+    UT_Stub_GetInt32StatusCode(Context, &status);
+
+    if (status >= 0)
+    {
+        UT_GetDataBuffer(UT_KEY(CFE_ES_GetAppID), &IdBuff, &BuffSize, &Position);
+        if (IdBuff != NULL && BuffSize == sizeof(*TaskIdPtr))
+        {
+            memcpy(TaskIdPtr, IdBuff, sizeof(*TaskIdPtr));
+        }
+        else
+        {
+            *TaskIdPtr = CFE_UT_ES_DEFAULT_TASKID;
+        }
+    }
+
+    if (status < 0)
+    {
+        *TaskIdPtr = CFE_ES_TASKID_UNDEFINED;
+    }
+}
+
 /*------------------------------------------------------------
  *
  * Default handler for CFE_ES_GetAppID coverage stub function

diff --git a/modules/core_api/ut-stubs/src/cfe_es_stubs.c b/modules/core_api/ut-stubs/src/cfe_es_stubs.c
@@ -31,6 +31,7 @@
 
 void UT_DefaultHandler_CFE_ES_AppID_ToIndex(void *, UT_EntryKey_t, const UT_StubContext_t *);
 void UT_DefaultHandler_CFE_ES_CopyToCDS(void *, UT_EntryKey_t, const UT_StubContext_t *);
+void UT_DefaultHandler_CFE_ES_CreateChildTask(void *, UT_EntryKey_t, const UT_StubContext_t *);
 void UT_DefaultHandler_CFE_ES_ExitApp(void *, UT_EntryKey_t, const UT_StubContext_t *);
 void UT_DefaultHandler_CFE_ES_GetAppID(void *, UT_EntryKey_t, const UT_StubContext_t *);
 void UT_DefaultHandler_CFE_ES_GetAppIDByName(void *, UT_EntryKey_t, const UT_StubContext_t *);
@@ -146,7 +147,7 @@ CFE_Status_t CFE_ES_CreateChildTask(CFE_ES_TaskId_t *TaskIdPtr, const char *Task
     UT_GenStub_AddParam(CFE_ES_CreateChildTask, CFE_ES_TaskPriority_Atom_t, Priority);
     UT_GenStub_AddParam(CFE_ES_CreateChildTask, uint32, Flags);
 
-    UT_GenStub_Execute(CFE_ES_CreateChildTask, Basic, NULL);
+    UT_GenStub_Execute(CFE_ES_CreateChildTask, Basic, UT_DefaultHandler_CFE_ES_CreateChildTask);
 
     return UT_GenStub_GetReturnValue(CFE_ES_CreateChildTask, CFE_Status_t);
 }

diff --git a/modules/msg/fsw/src/cfe_msg_msgid_v2.c b/modules/msg/fsw/src/cfe_msg_msgid_v2.c
@@ -40,6 +40,7 @@
 #include "cfe_msg.h"
 #include "cfe_msg_priv.h"
 #include "cfe_error.h"
+#include "cfe_sb.h"
 #include "cfe_platform_cfg.h"
 
 /* cFS MsgId definitions */

diff --git a/modules/sb/fsw/src/cfe_sb_priv.h b/modules/sb/fsw/src/cfe_sb_priv.h
@@ -693,7 +693,7 @@ int32 CFE_SB_ZeroCopyBufferValidate(CFE_SB_Buffer_t *BufPtr, CFE_SB_BufferD_t **
  * \note Assumes destination pointer is valid
  *
  * \param[in] RouteId The route ID to add destination node to
- * \param[in] DestPtr Pointer to the destination to add
+ * \param[in] NewNode Pointer to the destination to add
  */
 int32 CFE_SB_AddDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NewNode);
 
@@ -705,8 +705,8 @@ int32 CFE_SB_AddDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NewNo
  *
  * \note Assumes destination pointer is valid and in route
  *
- * \param[in] RouteId The route ID to remove destination node from
- * \param[in] DestPtr Pointer to the destination to remove
+ * \param[in] RouteId      The route ID to remove destination node from
+ * \param[in] NodeToRemove Pointer to the destination to remove
  */
 void CFE_SB_RemoveDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NodeToRemove);
 

diff --git a/modules/tbl/fsw/src/cfe_tbl_task.h b/modules/tbl/fsw/src/cfe_tbl_task.h
@@ -402,7 +402,7 @@ int32 CFE_TBL_TaskInit(void);
 ** \par Assumptions, External Events, and Notes:
 **          None
 **
-** \param[in] MessagePtr a pointer to the message received from the command pipe
+** \param[in] SBBufPtr Pointer to the message received from the command pipe
 **
 */
 void CFE_TBL_TaskPipe(CFE_SB_Buffer_t *SBBufPtr);