From d4caca84f6ccf7012ddfe20f163b36db0d0d9dee Mon Sep 17 00:00:00 2001 From: anh Date: Tue, 5 Nov 2019 09:03:49 -0500 Subject: [PATCH] Fix #385, fix misc. doxygen warning --- fsw/cfe-core/src/inc/cfe_es.h | 2 ++ fsw/cfe-core/src/inc/cfe_es_msg.h | 2 +- fsw/cfe-core/src/inc/cfe_fs.h | 8 ++++++-- fsw/cfe-core/src/inc/cfe_sb.h | 2 +- 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/fsw/cfe-core/src/inc/cfe_es.h b/fsw/cfe-core/src/inc/cfe_es.h index a3f47990a..e342b29e9 100644 --- a/fsw/cfe-core/src/inc/cfe_es.h +++ b/fsw/cfe-core/src/inc/cfe_es.h @@ -558,6 +558,8 @@ bool CFE_ES_RunLoop(uint32 *ExitStatus); ** wait indefinitely to avoid hanging a critical ** application because a non-critical app did not start. ** +** \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 diff --git a/fsw/cfe-core/src/inc/cfe_es_msg.h b/fsw/cfe-core/src/inc/cfe_es_msg.h index 018698ace..ffd46160d 100644 --- a/fsw/cfe-core/src/inc/cfe_es_msg.h +++ b/fsw/cfe-core/src/inc/cfe_es_msg.h @@ -747,7 +747,7 @@ ** the following telemetry: ** - \b \c \ES_CMDPC - command execution counter will ** increment -** - \B \C \ES_PERFFLTRMASK - the current performance filter mask +** - \b \c \ES_PERFFLTRMASK - the current performance filter mask ** value(s) should reflect the commanded value ** - The #CFE_ES_PERF_FILTMSKCMD_EID debug event message will be ** generated. diff --git a/fsw/cfe-core/src/inc/cfe_fs.h b/fsw/cfe-core/src/inc/cfe_fs.h index e64376749..3c1aacb05 100644 --- a/fsw/cfe-core/src/inc/cfe_fs.h +++ b/fsw/cfe-core/src/inc/cfe_fs.h @@ -113,8 +113,12 @@ int32 CFE_FS_ReadHeader(CFE_FS_Header_t *Hdr, int32 FileDes); ** This API will clear the specified #CFE_FS_Header_t variable and ** initialize the description field with the specified value ** -** \param[in] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be -** cleared and initialized +** \param[in] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be +** cleared and initialized +** +** \param[in] *Description Initializes Header's Description +** +** \param[in] SubType Initializes Header's SubType ** ** \sa #CFE_FS_WriteHeader ** diff --git a/fsw/cfe-core/src/inc/cfe_sb.h b/fsw/cfe-core/src/inc/cfe_sb.h index 255686e0e..749f95848 100644 --- a/fsw/cfe-core/src/inc/cfe_sb.h +++ b/fsw/cfe-core/src/inc/cfe_sb.h @@ -260,7 +260,7 @@ int32 CFE_SB_SetPipeOpts(CFE_SB_PipeId_t PipeId, ** ** \param[in] PipeId The pipe ID of the pipe to get options from. ** -** \param[out] OptsPtr A bit field of options. +** \param[out] *OptPtr A bit field of options. ** ** \returns ** \retcode #CFE_SUCCESS \retdesc \copydoc CFE_SUCCESS \endcode