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

doxygen misc warning #385

Closed
avan989 opened this issue Oct 30, 2019 · 0 comments · Fixed by #413
Closed

doxygen misc warning #385

avan989 opened this issue Oct 30, 2019 · 0 comments · Fixed by #413
Milestone

Comments

@avan989
Copy link
Contributor

avan989 commented Oct 30, 2019

Describe the bug

cfe/fsw/cfe-core/src/inc/cfe_es.h:560: warning: expected tag but found TK_LNKWORD token instead!

cfe/fsw/cfe-core/src/inc/cfe_es.h:569: warning: The following parameters of CFE_ES_WaitForSystemState(uint32 MinSystemState, uint32 TimeOutMilliseconds) are not documented:
parameter 'MinSystemState'

cfe/fsw/cfe-core/src/inc/cfe_es_msg.h:750: warning: Found unknown command `\B'

cfe/fsw/cfe-core/src/inc/cfe_es_msg.h:750: warning: Found unknown command `\C'

cfe/fsw/cfe-core/src/inc/cfe_fs.h:122: warning: The following parameters of CFE_FS_InitHeader(CFE_FS_Header_t *Hdr, const char *Description, uint32 SubType) are not documented:
parameter 'Description'
parameter 'SubType'

cfe/fsw/cfe-core/src/inc/cfe_sb.h:256: warning: argument 'OptsPtr' of command @param is not found in the argument list of CFE_SB_GetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 *OptPtr)

cfe/fsw/cfe-core/src/inc/cfe_sb.h:272: warning: The following parameters of CFE_SB_GetPipeOpts(CFE_SB_PipeId_t PipeId, uint8 *OptPtr) are not documented:
parameter 'OptPtr'

cfe/fsw/cfe-core/src/inc/cfe_sb_msg.h:560: warning: Illegal command \SB_PIPEOPTSEC as the argument of a \c command

To Reproduce
Steps to reproduce the behavior:

  1. make usersguide

System observed on:

  • Hardware
  • Ubuntu 18.04
  • doxygen 1.8.13, rc-6.7.0

Reporter Info
Anh Van, NASA Goddard

@skliper skliper added this to the 6.8.0 milestone Nov 1, 2019
skliper added a commit that referenced this issue Nov 15, 2019
Fixes #379, Fixes #380, Fixes #383, Fixes #384,
Fixes #385, Fixes #292
Code reviewed and approved at 20191106 and 20191113 CB
skliper added a commit that referenced this issue Nov 30, 2019
Fixes #379, Fixes #380, Fixes #383, Fixes #384,
Fixes #385, Fixes #392
Code reviewed and approved at 20191106 and 20191113 CB
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants