From cd04b0cb1ce3a1e0586f3246eb08fbbbc87b8fdc Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Fri, 9 Sep 2022 19:51:15 +0000 Subject: [PATCH] Fix #42, Resolve usersguide issues with doxygen 1.8.17 --- fsw/src/cs_compute.h | 51 ++++++++------------------------------------ fsw/src/cs_utils.h | 36 +++++++------------------------ 2 files changed, 17 insertions(+), 70 deletions(-) diff --git a/fsw/src/cs_compute.h b/fsw/src/cs_compute.h index c227e41..b18b146 100644 --- a/fsw/src/cs_compute.h +++ b/fsw/src/cs_compute.h @@ -44,26 +44,15 @@ * \par Assumptions, External Events, and Notes: * None * - * \param [in] *ResultsEntry A pointer to the entry in a table + * \param [in] ResultsEntry A pointer to the entry in a table * that we want to compute the * checksum on. Verified non-null by * calling function. * - * \param [in] ComputedCSValue A pointer to the computed checksum - * that will be assigned the checksum of - * the entry. Verified non-null by - * calling function. - * - * \param [in] DoneWithEntry A pointer to a bool that will be - * assigned a value based on whether or - * not the specified entry's checksum - * was completed. Verified non-null by - * calling function. - * - * \param [out] *ComputedCSValue Value used to determine the computed + * \param [out] ComputedCSValue Value used to determine the computed * checksum, if completed * - * \param [out] *DoneWithEntry Value that specifies whether or not + * \param [out] DoneWithEntry Value that specifies whether or not * the specified entry's checksum was * completed during this call. * @@ -84,26 +73,15 @@ int32 CS_ComputeEepromMemory(CS_Res_EepromMemory_Table_Entry_t *ResultsEntry, ui * \par Assumptions, External Events, and Notes: * None * - * \param [in] *ResultsEntry A pointer to the entry in a table + * \param [in] ResultsEntry A pointer to the entry in a table * that we want to compute the * checksum on. Verified non-null in * calling function. * - * \param [in] ComputedCSValue A pointer to the computed checksum - * that will be assigned the checksum of - * the entry. Verified non-null in - * calling function. - * - * \param [in] DoneWithEntry A pointer to a bool that will be - * assigned a value based on whether or - * not the specified entry's checksum - * was completed. Verified non-null in - * calling function. - * - * \param [out] *ComputedCSValue Value used to determine the computed + * \param [out] ComputedCSValue Value used to determine the computed * checksum, if completed * - * \param [out] *DoneWithEntry Value that specifies whether or not + * \param [out] DoneWithEntry Value that specifies whether or not * the specified entry's checksum was * completed during this call. * @@ -124,26 +102,15 @@ int32 CS_ComputeTables(CS_Res_Tables_Table_Entry_t *ResultsEntry, uint32 *Comput * \par Assumptions, External Events, and Notes: * None * - * \param [in] *ResultsEntry A pointer to the entry in a table + * \param [in] ResultsEntry A pointer to the entry in a table * that we want to compute the * checksum on. Verified non-null in * calling function. * - * \param [in] ComputedCSValue A pointer to the computed checksum - * that will be assigned the checksum of - * the entry. Verified non-null in - * calling function. - * - * \param [in] DoneWithEntry A pointer to a bool that will be - * assigned a value based on whether or - * not the specified entry's checksum - * was completed. Verified non-null in - * calling function. - * - * \param [out] *ComputedCSValue Value used to determine the computed + * \param [out] ComputedCSValue Value used to determine the computed * checksum, if completed * - * \param [out] *DoneWithEntry Value that specifies whether or not + * \param [out] DoneWithEntry Value that specifies whether or not * the specified entry's checksum was * completed during this call. * diff --git a/fsw/src/cs_utils.h b/fsw/src/cs_utils.h index 0b1cbff..0ecc937 100644 --- a/fsw/src/cs_utils.h +++ b/fsw/src/cs_utils.h @@ -143,16 +143,11 @@ void CS_GoToNextTable(void); * \par Assumptions, External Events, and Notes: * None * - * \param [in] *EntryPtr A pointer to a #CS_Res_Tables_Table_Entry_t - * that will be assigned an entry where the name - * field matches the name passed in. Calling - * function ensures this is non-null. - * - * \param [in] *Name The name associated with the entry we want + * \param [in] Name The name associated with the entry we want * to find. Calling function ensures this is * non-null. * - * \param [out] **EntryPtr A pointer to a #CS_Res_Tables_Table_Entry_t + * \param [out] EntryPtr A pointer to a #CS_Res_Tables_Table_Entry_t * pointer that contains the start address of the * entry whose name field matches the name passed in * in the table passed in. @@ -174,16 +169,11 @@ bool CS_GetTableResTblEntryByName(CS_Res_Tables_Table_Entry_t **EntryPtr, const * \par Assumptions, External Events, and Notes: * None * - * \param [in] *EntryPtr A pointer to a #CS_Def_Tables_Table_Entry_t - * that will be assigned an entry where the name - * field matches the name passed in. Calling - * function ensures this is non-null. - * - * \param [in] *Name The name associated with the entry we want + * \param [in] Name The name associated with the entry we want * to find. Calling function ensures this is * non-null. * - * \param [out] **EntryPtr A pointer to a #CS_Def_Tables_Table_Entry_t + * \param [out] EntryPtr A pointer to a #CS_Def_Tables_Table_Entry_t * pointer that contains the start address of the * entry whose name field matches the name passed in * in the table passed in. @@ -205,16 +195,11 @@ bool CS_GetTableDefTblEntryByName(CS_Def_Tables_Table_Entry_t **EntryPtr, const * \par Assumptions, External Events, and Notes: * None * - * \param [in] *EntryPtr A pointer to a #CS_Res_App_Table_Entry_t - * that will be assigned an entry where the name - * field matches the name passed in. Calling - * function ensures this is non-null. - * - * \param [in] Name The name associated with the entry we want + * \param [in] Name The name associated with the entry we want * to find. Calling function ensures this is * non-null. * - * \param [out] **EntryPtr A pointer to a #CS_Res_App_Table_Entry_t + * \param [out] EntryPtr A pointer to a #CS_Res_App_Table_Entry_t * pointer that contains the start address of the * entry whose name field matches the name passed in * in the table passed in. @@ -236,16 +221,11 @@ bool CS_GetAppResTblEntryByName(CS_Res_App_Table_Entry_t **EntryPtr, const char * \par Assumptions, External Events, and Notes: * None * - * \param [in] *EntryPtr A pointer to a #CS_Def_App_Table_Entry_t - * that will be assigned an entry where the name - * field matches the name passed in. Calling - * function ensures this is non-null. - * - * \param [in] Name The name associated with the entry we want + * \param [in] Name The name associated with the entry we want * to find. Calling function ensures this is * non-null. * - * \param [out] **EntryPtr A pointer to a #CS_Def_App_Table_Entry_t + * \param [out] EntryPtr A pointer to a #CS_Def_App_Table_Entry_t * pointer that contains the start address of the * entry whose name field matches the name passed in * in the table passed in.