furtest/pepperOS
1
0
Fork 0
forked from xamidev/pepperOS
Code Pull Requests Activity

Function comments (v1)

Browse Source
This commit is contained in:
xamidev
2026-03-13 12:51:29 +01:00
parent 8e2a612d88
commit 8026c33639
25 changed files with 560 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/STYLE.md
View File

@@ -71,12 +71,16 @@ Function prototypes should include parameter names and their data types.
## Commenting
Comments should describe what a function does and why, not how it does it.
Comments should describe what a function does and why, not how it does it. The preferred way of commenting functions is the following:
```c
/*
* This is the preferred style for multi-line
* comments in the Pepper kernel
* function_name - Function brief description
* @arg1: Argument 1 description
* @arg2: Argument 2 description
*
* A longer description can be featured here, explaining more
* in detail what the function does and why it does it.
*/
```