Skip to content
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.

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

Fix #2051, Resolve doxygen doc warnings and enforce in CI #2052

Merged
merged 1 commit into from
Feb 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions .github/workflows/build-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -69,6 +70,7 @@ jobs:
path: |
make_doc_stdout.txt
make_doc_stderr.txt
detaildesign-warnings.log

- name: Error Check
run: |
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions cmake/cfe-common.doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
#---------------------------------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions modules/sb/fsw/src/cfe_sb_priv.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion modules/tbl/fsw/src/cfe_tbl_task.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down