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

Poorly documented file #116

Open
ArielSAdamsNASA opened this issue Sep 23, 2022 · 0 comments
Open

Poorly documented file #116

ArielSAdamsNASA opened this issue Sep 23, 2022 · 0 comments

Comments

@ArielSAdamsNASA
Copy link

Describe the bug
Poorly documented large function

Expected behavior
Same behavior. Better documentation for future users/developers. Either document functions or remove empty comment blocks.

Code snips
One function example out of many:

elf2cfetbl/elf2cfetbl.c

Lines 817 to 821 in b6aa1c0

/**
*
*/
int32 AllocateSymbols(void)

Additional context
Caught by CodeQL - Security queries.
Several functions have empty comment blocks where documentation should go.

Reporter Info
Ariel Adams, MCSG Tech
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ArielSAdamsNASA