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

docs: improve code documentation- v1 #9604

Closed
wants to merge 1 commit into from

Conversation

zazie-codes
Copy link
Contributor

Make sure these boxes are signed before submitting your Pull Request -- thank you.

Link to redmine ticket:https://redmine.openinfosecfoundation.org/issues/6383

Describe changes:

  • used standard documentation within C programming ;'commenting code' to add accurate file descriptions.
    -added accurate file descriptions to each C file excluding 'autoconf.h and app-layer-dcerpc-common.h' as they do not exist.
    -added file and author tag in the files to elaborate each file description maintaining consistency with the Suricata's documentation style.
    -Ensure there are no syntax errors and grammatical errors in the document maintaining existing format.

  • ISSUE
    Ticket.6383

  • Notes
    The file description added is in line with your existing documentation standards and will enhance the documentations accessibility.
    The additions are clear and concise.

I'll appreciate your feedback and guidance on how to improve the changes.

src/app-layer-htp-libhtp.c Show resolved Hide resolved
src/app-layer-htp-libhtp.h Show resolved Hide resolved
src/app-layer-smb.c Show resolved Hide resolved
src/app-layer-smb.h Show resolved Hide resolved
src/app-layer.h Show resolved Hide resolved
src/app-layer.h Show resolved Hide resolved
@github-actions
Copy link

NOTE: This PR may contain new authors:

Liza <oparliza@gmail.com>

@victorjulien
Copy link
Member

Additionally, the commit message isn't properly formatted, and has no useful explanation of what the commit is about.

@codecov
Copy link

codecov bot commented Oct 12, 2023

Codecov Report

Merging #9604 (686f893) into master (1a132f4) will increase coverage by 0.05%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #9604      +/-   ##
==========================================
+ Coverage   82.28%   82.34%   +0.05%     
==========================================
  Files         968      968              
  Lines      274275   274275              
==========================================
+ Hits       225700   225861     +161     
+ Misses      48575    48414     -161     
Flag Coverage Δ
fuzzcorpus 64.52% <ø> (+0.18%) ⬆️
suricata-verify 60.92% <ø> (-0.01%) ⬇️
unittests 62.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@jufajardini jufajardini added the outreachy Contributions made by Outreachy applicants label Oct 12, 2023
@zazie-codes zazie-codes changed the title C File contribution docs: improve code documentation- v1 Oct 12, 2023
@inashivb inashivb closed this Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
outreachy Contributions made by Outreachy applicants
4 participants