Skip to content

Refactor Code Comments and Structure for Readability#44

Merged
KorelU merged 7 commits into
mainfrom
RefactorCodeCommentsAndStructureForReadability
Jun 15, 2025
Merged

Refactor Code Comments and Structure for Readability#44
KorelU merged 7 commits into
mainfrom
RefactorCodeCommentsAndStructureForReadability

Conversation

@KorelU
Copy link
Copy Markdown
Collaborator

@KorelU KorelU commented Jun 15, 2025

This PR refactors the existing codebase to improve readability by:

  • Revising and standardizing comments to align with Linux kernel coding guidelines.
  • Adding comments to every existing function in the codebase
  • Separating the module parameters from main into their own file for modularity.

KorelU added 7 commits June 15, 2025 15:24
Refactor comments and add comments for each function in vlan.c file such that they adhere to the Linux Kernely style comment block

Signed-off-by: Korel <Korelucpinar@gmail.com>
Refactor comments and add comments for each function in trusted_interfaces.c file such that they adhere to the Linux Kernely style comment block

Signed-off-by: Korel <Korelucpinar@gmail.com>
Refactor comments and add comments for each function in rate_limitc file such that they adhere to the Linux Kernely style comment block

Signed-off-by: Korel <Korelucpinar@gmail.com>
Refactor comments and add comments for each function in dhcp.c file such that they adhere to the Linux Kernel style comment block

Signed-off-by: Korel <Korelucpinar@gmail.com>
Seperate the module parameters into a sperate file to help wiht readability. Comments have also been added to each module parameter funciton to help wit understanding its functionality

Signed-off-by: Korel <Korelucpinar@gmail.com>
Update the hook and associated function name to more accurately represent their funciton.

Signed-off-by: Korel <Korelucpinar@gmail.com>
Refactor comments and add comments for each function in main.c file such that they adhere to the Linux Kernel style comment block

Signed-off-by: Korel <Korelucpinar@gmail.com>
@KorelU KorelU force-pushed the RefactorCodeCommentsAndStructureForReadability branch from 266c50d to f154de0 Compare June 15, 2025 22:25
@KorelU KorelU merged commit fe24fe6 into main Jun 15, 2025
2 checks passed
@KorelU KorelU deleted the RefactorCodeCommentsAndStructureForReadability branch June 15, 2025 22:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant