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

Standardize/clean function description comments #1336

Closed
skliper opened this issue Apr 13, 2021 · 0 comments · Fixed by #1429 or #1481
Closed

Standardize/clean function description comments #1336

skliper opened this issue Apr 13, 2021 · 0 comments · Fixed by #1429 or #1481
Assignees
@jphickey
Labels
CFS-40 docs This change only affects documentation.
Milestone
Caelum

Comments

@skliper
Copy link
Contributor

skliper commented Apr 13, 2021 •
edited
Loading

Is your feature request related to a problem? Please describe.
They need a general scrub, out of date references, etc. Example:

cFE/modules/es/fsw/src/cfe_es_cds.c

Lines 242 to 248 in e80aae9

/*******************************************************************/
/*
* CFE_ES_CDS_CacheFlush()
*
* NOTE: For complete prolog information, see 'cfe_es_cds.h'
*/
/*******************************************************************/

Should clearly indicate implementations that are API's vs internal/helper functions

Describe the solution you'd like
Automated cleanup.

Describe alternatives you've considered
None

Additional context
Code review

Requester Info
Jacob Hageman - NASA/GSFC
@skliper skliper added docs This change only affects documentation. CFS-40 labels Apr 13, 2021
@skliper skliper added this to the 7.0.0 milestone Apr 13, 2021
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ES module
587d241
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SB module
f2e066e
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in EVS module
3bcf5af
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in FS module
875915c
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TBL module
5d77158
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TIME module
c65e50a
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in MSG module
be82721
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ResourceID module
f7f0452
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SBR module
da57f4d
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ES module
71774de
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SB module
ecd85c3
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in EVS module
862d599
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in FS module
69a21af
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TBL module
948c096
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TIME module
8fbf7c6
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in MSG module
7421d8f
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ResourceID module
a91cc2e
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SBR module
534d0cd
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ES module
f2e7319
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SB module
ebbda49
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in EVS module
e15a552
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in FS module
70af1ec
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TBL module
d0aabae
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TIME module
abeb742
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in MSG module
da1a910
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ResourceID module
0053ac5
jphickey added a commit to jphickey/cFE that referenced this issue Apr 27, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SBR module
a355c6f
@astrogeco astrogeco mentioned this issue Apr 28, 2021
Merged
jphickey added a commit to jphickey/cFE that referenced this issue Apr 28, 2021
@jphickey
Fix nasa#1336, remove specific header names from comments
a3b8e80 
Per CCB review on 2021-04-28, this removes the reference
to a specific header file name in the comment.
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ES module
8d341bb
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SB module
a301f25
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in EVS module
a2f3aaa
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in FS module
8010a9b
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TBL module
62716f2
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in TIME module
5f9b928
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in MSG module
146d8c4
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in ResourceID module
5d79991
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, Function comment blocks in SBR module
edc4b2a
jphickey added a commit to jphickey/cFE that referenced this issue Apr 29, 2021
@jphickey
Fix nasa#1336, remove specific header names from comments
dc59e35 
Per CCB review on 2021-04-28, this removes the reference
to a specific header file name in the comment.
astrogeco added a commit that referenced this issue May 4, 2021
@astrogeco
Merge pull request #1429 from jphickey/fix-1336-function-comments
2bc0cc7 
Fix #1336, function block comments
@astrogeco astrogeco mentioned this issue May 5, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jphickey jphickey

Labels
CFS-40 docs This change only affects documentation.
Projects
None yet
Milestone
Caelum
Development

Successfully merging a pull request may close this issue.

Fix #1336, function block comments jphickey/cFE
cFE Integration candidate: 2021-05-04 nasa/cFE
2 participants
@jphickey @skliper