From dd37c14e2ad12946f4960225177fafdd6451ded9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9on=20Avic=20Simmons?= Date: Fri, 18 Sep 2026 08:11:10 -0400 Subject: [PATCH] docs: fix 12 typos in comments and documentation --- config/default_cs_msgdefs.h | 4 ++-- config/default_cs_tbldefs.h | 10 +++++----- fsw/src/cs_app_cmds.h | 2 +- fsw/src/cs_compute.h | 2 +- fsw/src/cs_eeprom_cmds.h | 4 ++-- fsw/src/cs_memory_cmds.h | 4 ++-- fsw/src/cs_table_cmds.h | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/config/default_cs_msgdefs.h b/config/default_cs_msgdefs.h index 17851b7..2a99807 100644 --- a/config/default_cs_msgdefs.h +++ b/config/default_cs_msgdefs.h @@ -59,13 +59,13 @@ typedef struct uint16 AppCSErrCounter; /**< \brief App miscompare counter */ uint16 TablesCSErrCounter; /**< \brief Tables miscompare counter */ uint16 CfeCoreCSErrCounter; /**< \brief cFE core miscompare counter */ - uint16 OSCSErrCounter; /**< \brief OS code segment miscopmare counter */ + uint16 OSCSErrCounter; /**< \brief OS code segment miscompare counter */ uint16 CurrentCSTable; /**< \brief Current table being checksummed */ uint16 CurrentEntryInTable; /**< \brief Current entry ID in table being checksummed */ uint32 EepromBaseline; /**< \brief Baseline checksum for all of EEPROM */ uint32 OSBaseline; /**< \brief Baseline checksum for the OS code segment */ - uint32 CfeCoreBaseline; /**< \brief Basline checksum for the cFE core */ + uint32 CfeCoreBaseline; /**< \brief Baseline checksum for the cFE core */ CFE_ES_MemAddress_t LastOneShotAddress; /**< \brief Address used in last one shot checksum command */ uint32 LastOneShotSize; /**< \brief Size used in the last one shot checksum command */ diff --git a/config/default_cs_tbldefs.h b/config/default_cs_tbldefs.h index 36a0f19..5a0c46d 100644 --- a/config/default_cs_tbldefs.h +++ b/config/default_cs_tbldefs.h @@ -51,7 +51,7 @@ typedef struct } CS_Def_EepromMemory_Table_Entry_t; /** - * \brief Data structure for the Eeporom or Memory results table + * \brief Data structure for the EEPROM or Memory results table */ typedef struct { @@ -61,7 +61,7 @@ typedef struct uint32 NumBytesToChecksum; /**< \brief The number of Bytes to Checksum */ uint32 ComparisonValue; /**< \brief The Memory Integrity Value */ uint32 ByteOffset; /**< \brief Where a previous unfinished calc left off */ - uint32 TempChecksumValue; /**< \brief The unfinished caluculation */ + uint32 TempChecksumValue; /**< \brief The unfinished calculation */ uint32 Filler32; /**< \brief Padding */ } CS_Res_EepromMemory_Table_Entry_t; @@ -94,8 +94,8 @@ typedef struct uint32 NumBytesToChecksum; /**< \brief The number of Bytes to Checksum */ uint32 ComparisonValue; /**< \brief The Memory Integrity Value */ uint32 ByteOffset; /**< \brief Where a previous unfinished calc left off */ - uint32 TempChecksumValue; /**< \brief The unfinished caluculation */ - CFE_TBL_HandleId_t TblHandleID; /**< \brief handle recieved from CFE_TBL */ + uint32 TempChecksumValue; /**< \brief The unfinished calculation */ + CFE_TBL_HandleId_t TblHandleID; /**< \brief handle received from CFE_TBL */ bool IsCSOwner; /**< \brief Is CS the original owner of this table */ bool Filler8; /**< \brief Padding */ char Name[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]; /**< \brief name of the table */ @@ -112,7 +112,7 @@ typedef struct uint32 NumBytesToChecksum; /**< \brief The number of Bytes to Checksum */ uint32 ComparisonValue; /**< \brief The Memory Integrity Value */ uint32 ByteOffset; /**< \brief Where a previous unfinished calc left off */ - uint32 TempChecksumValue; /**< \brief The unfinished caluculation */ + uint32 TempChecksumValue; /**< \brief The unfinished calculation */ char Name[CFE_MISSION_MAX_API_LEN]; /**< \brief name of the app */ } CS_Res_App_Table_Entry_t; diff --git a/fsw/src/cs_app_cmds.h b/fsw/src/cs_app_cmds.h index 3a8b4c7..75ca0f8 100644 --- a/fsw/src/cs_app_cmds.h +++ b/fsw/src/cs_app_cmds.h @@ -86,7 +86,7 @@ CFE_Status_t CS_EnableAppsCmd(const CS_EnableAppsCmd_t *CmdPtr); CFE_Status_t CS_ReportBaselineAppCmd(const CS_ReportBaselineAppCmd_t *CmdPtr); /** - * \brief Process a recopmute baseline of an app command + * \brief Process a recompute baseline of an app command * * \par Description * Recomputes the checksum of an app and use that diff --git a/fsw/src/cs_compute.h b/fsw/src/cs_compute.h index 834cec7..79b8f35 100644 --- a/fsw/src/cs_compute.h +++ b/fsw/src/cs_compute.h @@ -161,7 +161,7 @@ void CS_RecomputeTablesChildTask(void); void CS_RecomputeAppChildTask(void); /** - * \brief Child task main function for computing a one shot calculatipn + * \brief Child task main function for computing a one shot calculation * * \par Description * Child task main function that is spawned when a one shot diff --git a/fsw/src/cs_eeprom_cmds.h b/fsw/src/cs_eeprom_cmds.h index 95cbf06..c3a8cde 100644 --- a/fsw/src/cs_eeprom_cmds.h +++ b/fsw/src/cs_eeprom_cmds.h @@ -70,7 +70,7 @@ CFE_Status_t CS_DisableEepromCmd(const CS_DisableEepromCmd_t *CmdPtr); CFE_Status_t CS_EnableEepromCmd(const CS_EnableEepromCmd_t *CmdPtr); /** - * \brief Proccess a report baseline of an EEPROM Entry command + * \brief Process a report baseline of an EEPROM Entry command * * \par Description * Reports the baseline checksum of the specified EEPROM table @@ -109,7 +109,7 @@ CFE_Status_t CS_ReportBaselineEntryIDEepromCmd(const CS_ReportBaselineEntryIDEep CFE_Status_t CS_DisableEntryIDEepromCmd(const CS_DisableEntryIDEepromCmd_t *CmdPtr); /** - * \brief Process a recopmute baseline of an EEPROM table entry command + * \brief Process a recompute baseline of an EEPROM table entry command * * \par Description * Recomputes the checksum of an EEPROM table entry and use that diff --git a/fsw/src/cs_memory_cmds.h b/fsw/src/cs_memory_cmds.h index 91d949a..74b5365 100644 --- a/fsw/src/cs_memory_cmds.h +++ b/fsw/src/cs_memory_cmds.h @@ -70,7 +70,7 @@ CFE_Status_t CS_DisableMemoryCmd(const CS_DisableMemoryCmd_t *CmdPtr); CFE_Status_t CS_EnableMemoryCmd(const CS_EnableMemoryCmd_t *CmdPtr); /** - * \brief Proccess a report baseline of a Memory Entry command + * \brief Process a report baseline of a Memory Entry command * * \par Description * Reports the baseline checksum of the specified Memory table @@ -109,7 +109,7 @@ CFE_Status_t CS_ReportBaselineEntryIDMemoryCmd(const CS_ReportBaselineEntryIDMem CFE_Status_t CS_DisableEntryIDMemoryCmd(const CS_DisableEntryIDMemoryCmd_t *CmdPtr); /** - * \brief Process a recopmute baseline of a Memory table entry command + * \brief Process a recompute baseline of a Memory table entry command * * \par Description * Recomputes the checksum of a Memory table entry and use that diff --git a/fsw/src/cs_table_cmds.h b/fsw/src/cs_table_cmds.h index 3662cea..c2c6366 100644 --- a/fsw/src/cs_table_cmds.h +++ b/fsw/src/cs_table_cmds.h @@ -70,7 +70,7 @@ CFE_Status_t CS_DisableTablesCmd(const CS_DisableTablesCmd_t *CmdPtr); CFE_Status_t CS_EnableTablesCmd(const CS_EnableTablesCmd_t *CmdPtr); /** - * \brief Proccess a report baseline of a Table command + * \brief Process a report baseline of a Table command * * \par Description * Reports the baseline checksum of the specified table