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.

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

Jump to bottom

Fix #535 and #537, User's guide doxygen issues #538

Merged
merged 2 commits into from
Mar 18, 2020
Merged

Fix #535 and #537, User's guide doxygen issues #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7e023a
Fix #535, Update user's guide pdf generation
skliper Mar 3, 2020
9325ce2
Fix #537, Remove private files from user's guide
skliper Mar 3, 2020
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
4 changes: 1 addition & 3 deletions cmake/cfe-usersguide.doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,4 @@ INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/cfe_usersguide.dox
PREDEFINED += @USERGUIDE_PREDEFINED@

# Bring in the cFE header files for the documentation of the various API calls
INPUT += \
@MISSION_USERGUIDE_HEADERFILES@ \
@USERGUIDE_MISC_ADDITION@
INPUT += @MISSION_USERGUIDE_HEADERFILES@
8 changes: 0 additions & 8 deletions cmake/mission_build.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,14 +232,6 @@ function(prepare)
"${osal_MISSION_DIR}/src/os/inc/*.h")
string(REPLACE ";" " \\\n" MISSION_OSAL_HEADERFILES "${MISSION_OSAL_HEADERFILES}")

# Addition to usersguide
file(GLOB USERGUIDE_MISC_ADDITION
"${cfe-core_MISSION_DIR}/src/inc/private/*.h"
"${cfe-core_MISSION_DIR}/src/sb/*"
"${cfe-core_MISSION_DIR}/src/es/*"
"${cfe-core_MISSION_DIR}/src/evs/*")
string(REPLACE ";" " \\\n" USERGUIDE_MISC_ADDITION "${USERGUIDE_MISC_ADDITION}")

# PREDEFINED
set(USERGUIDE_PREDEFINED
"MESSAGE_FORMAT_IS_CCSDS")
Expand Down
7 changes: 3 additions & 4 deletions fsw/cfe-core/src/inc/cfe_es.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,9 +561,9 @@ bool CFE_ES_RunLoop(uint32 *ExitStatus);
** \param[in] MinSystemState Determine the state of the App
**
** \returns
** CFE_SUCCESS if state was successfully achieved
** CFE_ES_OPERATION_TIMED_OUT if the timeout was reached
** (or other defined error code in case of error)
** \retcode #CFE_SUCCESS \retdesc State successfully achieved \endcode
** \retcode #CFE_ES_OPERATION_TIMED_OUT \retdesc Timeout was reached \endcode
** \endreturns
**
** \sa #CFE_ES_RunLoop
**
Expand Down Expand Up @@ -969,7 +969,6 @@ int32 CFE_ES_WriteToSysLog(const char *SpecStringPtr, ...) OS_PRINTF(1,2);
** a single value. Nominally, the user should set this value to zero.
**
** \param[in] TypeCRC One of the following CRC algorithm selections:
**
** \arg \c CFE_MISSION_ES_CRC_8 - (Not currently implemented)
** \arg \c CFE_MISSION_ES_CRC_16 - a CRC-16 algorithm
** \arg \c CFE_MISSION_ES_CRC_32 - (not currently implemented)
Expand Down