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

Doxygen warnings #681

Closed
lbleier-GSFC opened this issue May 6, 2020 · 1 comment · Fixed by #686 or #712
Closed

Doxygen warnings #681

lbleier-GSFC opened this issue May 6, 2020 · 1 comment · Fixed by #686 or #712
Assignees
@CDKnightNASA
Labels
docs This change only affects documentation. enhancement
Milestone
Bootes

Comments

@lbleier-GSFC
Copy link

Describe the bug
Doxygen warnings due to lack of documentation in the following files:

  • cFS/cfe/fsw/cfe-core/src/tbl/cfe_tbl_internal.c
  • cFS/cfe/fsw/cfe-core/src/tbl/cfe_tbl_internal.h

Specifically for function CFE_TBL_LoadFromFile in both files

To Reproduce
Steps to reproduce the behavior:

  1. Build documentation using make doc
  2. Observe relevant warnings in ../cFS/build/doc/warnings.log

Expected behavior
Functions should be properly documented to avoid warnings

Reporter Info
Leor Bleier, NASA GSFC\Code 582
@CDKnightNASA CDKnightNASA self-assigned this May 6, 2020
@CDKnightNASA
Copy link
Contributor

ref #503 changes

@skliper skliper added this to the 6.8.0 milestone May 7, 2020
@skliper skliper added the docs This change only affects documentation. label May 7, 2020
CDKnightNASA added a commit to CDKnightNASA/cFE that referenced this issue May 7, 2020
@CDKnightNASA
fix nasa#681 - corrected doxygen for tbl
4eda822
CDKnightNASA added a commit to CDKnightNASA/cFE that referenced this issue May 7, 2020
@CDKnightNASA
fix nasa#681 - corrected doxygen for tbl
75c42bf
@lbleier-GSFC lbleier-GSFC mentioned this issue May 8, 2020
Merged
@CDKnightNASA CDKnightNASA mentioned this issue May 8, 2020
Merged
astrogeco added a commit that referenced this issue May 19, 2020
@astrogeco
Merge pull request #686 from CDKnightNASA/fix-681-tbl_doxygen
c72b0ba 
Fix #681, Resolve doxygen warnings for tbl
@astrogeco astrogeco mentioned this issue May 19, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CDKnightNASA CDKnightNASA

Labels
docs This change only affects documentation. enhancement
Projects
None yet
Milestone
Bootes
3 participants
@CDKnightNASA @skliper @lbleier-GSFC