docs: improve code documentation- v1 #9604
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.