Merge pull request #2163 from thnkslprpt/fix-2162-comment-cleanup

Fix #2162, Remove redundant/inconsistent comments (/* end of function */, /* end if */ etc.) and clean up empty lines.
nasa · Oct 11, 2022 · 6b85824 · 6b85824
2 parents 7494441 + b7bf34c
commit 6b85824
Show file tree

Hide file tree

Showing 102 changed files with 255 additions and 1,764 deletions.
diff --git a/cmake/target/inc/target_config.h b/cmake/target/inc/target_config.h
@@ -132,7 +132,6 @@ typedef const struct
      * File name of startup script
      */
     const char *NonvolStartupFile;
-
 } Target_CfeConfigData;
 
 /**
@@ -197,7 +196,6 @@ typedef const struct
     CFE_ConfigName_t *    CoreModuleList;    /**< List of CFE core support module names that are statically linked */
     CFE_ConfigName_t
         *StaticAppList; /**< List of additional CFS Applications that are statically linked into this binary */
-
 } Target_ConfigData;
 
 /**

diff --git a/docs/cFE Application Developers Guide.md b/docs/cFE Application Developers Guide.md
@@ -790,7 +790,6 @@ uint32 ConvertSecs2Ticks(uint32 Seconds)
 		( (Seconds * 1000000) + TickDurationInMicroSec - 1 ) / TickDurationInMicroSec;
 
 	return(NumOfTicks);
-
 }
 ```
 ## 5.7 OS Queues, Semaphores and Mutexes
@@ -1282,7 +1281,7 @@ void SAMPLE_TaskMain(void)
     }
     CFE_EVS_SendEvent(CFE_TBL_EXIT_ERR_EID, CFE_EVS_ERROR,
                       "SAMPLE Task terminating, err = 0x%X", Status);
-} /* End of SAMPLE_TaskMain() */
+}
 ```
 
 ### 5.10.4	Standard CRC Calculations
@@ -1821,7 +1820,6 @@ typedef struct
   */
   uint8          CmdCounter;
   uint8          ErrCounter;
-
 } SAMPLE_HkPacket_t;
 
 
@@ -1884,24 +1882,20 @@ containing just a CFE_MSG_Message_t is invalid per the CCSDS standard.
 ```c
 typedef struct
 {
-
     uint8 FunctionCode; /**< \brief Command Function Code */
                         /* bits shift ---------description-------- */
                         /* 0x7F  0    Command function code        */
                         /* 0x80  7    Reserved                     */
 
     uint8 Checksum; /**< \brief Command checksum  (all bits, 0xFF)      */
-
 } CFE_MSG_CommandSecondaryHeader_t;
 
 /**
  * \brief cFS telemetry secondary header
  */
 typedef struct
 {
-
     uint8 Time[6]; /**< \brief Time, big endian: 4 byte seconds, 2 byte subseconds */
-
 } CFE_MSG_TelemetrySecondaryHeader_t;
 ```
 
@@ -2131,7 +2125,6 @@ typedef struct
   ** Task command interface counters...
   */
   uint8          Data[SAMPLE_BIGPKT_DATALEN];
-
 } SAMPLE_BigPkt_t;
 
 typedef union
@@ -3123,7 +3116,6 @@ typedef struct
     uint32  TimeSubSeconds;        /* File creation timestamp (sub-seconds) */
 
     char    Description[32];       /* File description */
-
 } CFE_FS_Header_t;
 ```
 

diff --git a/modules/cfe_assert/src/cfe_assert_priv.h b/modules/cfe_assert/src/cfe_assert_priv.h
@@ -148,7 +148,6 @@ typedef struct
      * Line number of source file that produced "StoredStatus"
      */
     uint32 StoredLine;
-
 } CFE_Assert_Global_t;
 
 extern CFE_Assert_Global_t CFE_Assert_Global;

diff --git a/modules/cfe_testcase/src/cfe_test_table.c b/modules/cfe_testcase/src/cfe_test_table.c
@@ -32,7 +32,6 @@
 /* Setup function to register a table */
 void RegisterTestTable(void)
 {
-
     UtAssert_INT32_EQ(CFE_TBL_Register(&CFE_FT_Global.TblHandle, CFE_FT_Global.TblName, sizeof(TBL_TEST_Table_t),
                                        CFE_TBL_OPT_DEFAULT, NULL),
                       CFE_SUCCESS);

diff --git a/modules/cfe_testcase/src/time_arithmetic_test.c b/modules/cfe_testcase/src/time_arithmetic_test.c
@@ -108,7 +108,7 @@ void TestTimeCompare(void)
     UtAssert_UINT32_EQ(CFE_TIME_Compare(time1, time2), CFE_TIME_EQUAL);
     UtAssert_UINT32_EQ(CFE_TIME_Compare(time2, time1), CFE_TIME_EQUAL);
 
-    // time1 > time2 here due to the roll over handling of the comparison
+    /* time1 > time2 here due to the roll over handling of the comparison */
     time1.Seconds    = 1;
     time1.Subseconds = 1;
     time2.Seconds    = UINT32_MAX;

diff --git a/modules/config/fsw/src/cfe_config_get.c b/modules/config/fsw/src/cfe_config_get.c
@@ -33,8 +33,6 @@
 #include <string.h>
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_GetValue
  *
  * Defined per public API
  * See description in header file for argument/return detail
@@ -54,8 +52,6 @@ uint32 CFE_Config_GetValue(CFE_ConfigId_t ConfigId)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_GetObjPointer
  *
  * Defined per public API
  * See description in header file for argument/return detail
@@ -75,8 +71,6 @@ const void *CFE_Config_GetObjPointer(CFE_ConfigId_t ConfigId)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_GetObjPointer
  *
  * Defined per public API
  * See description in header file for argument/return detail
@@ -96,8 +90,6 @@ const char *CFE_Config_GetString(CFE_ConfigId_t ConfigId)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_GetName
  *
  * Defined per public API
  * See description in header file for argument/return detail
@@ -118,8 +110,6 @@ const char *CFE_Config_GetName(CFE_ConfigId_t ConfigId)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_GetIdByName
  *
  * Defined per public API
  * See description in header file for argument/return detail
@@ -149,8 +139,6 @@ CFE_ConfigId_t CFE_Config_GetIdByName(const char *Name)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_GetIdByName
  *
  * Defined per public API
  * See description in header file for argument/return detail

diff --git a/modules/config/fsw/src/cfe_config_init.c b/modules/config/fsw/src/cfe_config_init.c
@@ -52,8 +52,6 @@ bool CFE_Config_StrCaseEq(const char *c1, const char *c2)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_FindTargetKeyValue
  *
  * Internal helper routine only, not part of API.
  *
@@ -200,8 +198,6 @@ void CFE_Config_SetupBasicBuildInfo(void)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_Init
  *
  * CFE core internal function
  * See description in header file for argument/return detail

diff --git a/modules/config/fsw/src/cfe_config_lookup.c b/modules/config/fsw/src/cfe_config_lookup.c
@@ -45,8 +45,6 @@
 CFE_Config_Global_t CFE_Config_Global;
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_LocateConfigRecordByID
  *
  * Application scope internal function
  * See description in header file for argument/return detail

diff --git a/modules/config/fsw/src/cfe_config_set.c b/modules/config/fsw/src/cfe_config_set.c
@@ -30,8 +30,6 @@
 #include "cfe_config_priv.h"
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_SetValue
  *
  * CFE core internal function
  * See description in header file for argument/return detail
@@ -50,8 +48,6 @@ void CFE_Config_SetValue(CFE_ConfigId_t ConfigId, uint32 Value)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_SetObjPointer
  *
  * CFE core internal function
  * See description in header file for argument/return detail
@@ -70,8 +66,6 @@ void CFE_Config_SetObjPointer(CFE_ConfigId_t ConfigId, const void *Ptr)
 }
 
 /*----------------------------------------------------------------
- *
- * Function: CFE_Config_SetString
  *
  * CFE core internal function
  * See description in header file for argument/return detail

diff --git a/modules/core_api/fsw/inc/cfe_es_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_es_extern_typedefs.h
@@ -44,7 +44,6 @@
  */
 enum CFE_ES_LogMode
 {
-
     /**
      * @brief Overwrite Log Mode
      */
@@ -68,7 +67,6 @@ typedef uint8 CFE_ES_LogMode_Enum_t;
  */
 enum CFE_ES_ExceptionAction
 {
-
     /**
      * @brief Restart application if exception occurs
      */
@@ -92,7 +90,6 @@ typedef uint8 CFE_ES_ExceptionAction_Enum_t;
  */
 enum CFE_ES_AppType
 {
-
     /**
      * @brief CFE core application
      */
@@ -175,7 +172,6 @@ enum CFE_ES_RunStatus
      * @brief Reserved value, marker for the maximum state
      */
     CFE_ES_RunStatus_MAX
-
 };
 
 /**
@@ -190,7 +186,6 @@ typedef uint32 CFE_ES_RunStatus_Enum_t;
  */
 enum CFE_ES_SystemState
 {
-
     /**
      * @brief reserved
      */
@@ -248,7 +243,6 @@ typedef uint32 CFE_ES_SystemState_Enum_t;
  */
 enum CFE_ES_LogEntryType
 {
-
     /**
      * @brief Log entry from a core subsystem
      */
@@ -272,7 +266,6 @@ typedef uint8 CFE_ES_LogEntryType_Enum_t;
  */
 enum CFE_ES_AppState
 {
-
     /**
      * @brief Initial state before app thread is started
      */
@@ -484,7 +477,6 @@ typedef struct CFE_ES_AppInfo
                                                         \brief The Application's Main Task ID */
     uint32 NumOfChildTasks;                        /**< \cfetlmmnemonic \ES_CHILDTASKS
                                                         \brief Number of Child tasks for an App */
-
 } CFE_ES_AppInfo_t;
 
 /**

diff --git a/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h b/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h
@@ -61,7 +61,6 @@ typedef struct CFE_EVS_BinFilter
 {
     uint16 EventID; /**< \brief Numerical event identifier */
     uint16 Mask;    /**< \brief Binary filter mask value */
-
 } CFE_EVS_BinFilter_t;
 
 #endif /* CFE_EVS_API_TYPEDEFS_H */
diff --git a/modules/core_api/fsw/inc/cfe_evs_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_evs_extern_typedefs.h
@@ -42,7 +42,6 @@
  */
 enum CFE_EVS_MsgFormat
 {
-
     /**
      * @brief Short Format Messages
      */
@@ -66,7 +65,6 @@ typedef uint8 CFE_EVS_MsgFormat_Enum_t;
  */
 enum CFE_EVS_LogMode
 {
-
     /**
      * @brief Overwrite Log Mode
      */
@@ -90,7 +88,6 @@ typedef uint8 CFE_EVS_LogMode_Enum_t;
  */
 enum CFE_EVS_EventType
 {
-
     /**
      * @brief Events that are intended only for debugging, not nominal operations
      */
@@ -124,7 +121,6 @@ typedef uint16 CFE_EVS_EventType_Enum_t;
  */
 enum CFE_EVS_EventFilter
 {
-
     /**
      * @brief Binary event filter
      */
@@ -143,7 +139,6 @@ typedef uint8 CFE_EVS_EventFilter_Enum_t;
  */
 enum CFE_EVS_EventOutput
 {
-
     /**
      * @brief Output Port 1
      */

diff --git a/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h b/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h
@@ -75,7 +75,6 @@ typedef enum
     CFE_FS_FileWriteEvent_RECORD_WRITE_ERROR, /**< Unable to write data record */
 
     CFE_FS_FileWriteEvent_MAX /* placeholder, no-op, keep last */
-
 } CFE_FS_FileWriteEvent_t;
 
 /**
@@ -133,7 +132,6 @@ typedef struct CFE_FS_FileWriteMetaData
 
     CFE_FS_FileWriteGetData_t GetData; /**< Application callback to get a data record */
     CFE_FS_FileWriteOnEvent_t OnEvent; /**< Application callback for abstract event processing */
-
 } CFE_FS_FileWriteMetaData_t;
 
 #endif /* CFE_FS_API_TYPEDEFS_H */
diff --git a/modules/core_api/fsw/inc/cfe_fs_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_fs_extern_typedefs.h
@@ -60,7 +60,6 @@
  */
 enum CFE_FS_SubType
 {
-
     /**
      * @brief Executive Services Exception/Reset Log Type
      *
@@ -216,7 +215,6 @@ typedef struct CFE_FS_Header
     uint32 TimeSubSeconds; /**< \brief File creation timestamp (sub-seconds) */
 
     char Description[CFE_FS_HDR_DESC_MAX_LEN]; /**< \brief File description */
-
 } CFE_FS_Header_t;
 
 #endif /* CFE_EDS_ENABLED_BUILD */

diff --git a/modules/core_api/fsw/inc/cfe_sb_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_sb_extern_typedefs.h
@@ -46,7 +46,6 @@
  */
 enum CFE_SB_QosPriority
 {
-
     /**
      * @brief Normal priority level
      */
@@ -70,7 +69,6 @@ typedef uint8 CFE_SB_QosPriority_Enum_t;
  */
 enum CFE_SB_QosReliability
 {
-
     /**
      * @brief Normal (best-effort) reliability
      */

diff --git a/modules/core_api/fsw/inc/cfe_tbl_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_tbl_extern_typedefs.h
@@ -44,7 +44,6 @@
  */
 enum CFE_TBL_BufferSelect
 {
-
     /**
      * @brief Select the Inactive buffer for validate or dump
      */