Skip to content

Fix #42, Resolve usersguide issues with doxygen 1.8.17 #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2022
Merged

Fix #42, Resolve usersguide issues with doxygen 1.8.17 #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 9 additions & 42 deletions fsw/src/cs_compute.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand All @@ -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.
*
Expand All @@ -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.
*
Expand Down
36 changes: 8 additions & 28 deletions fsw/src/cs_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand Down