diff options
| author | Freya Murphy <freya@freyacat.org> | 2025-05-06 16:51:32 -0400 |
|---|---|---|
| committer | Freya Murphy <freya@freyacat.org> | 2025-05-06 16:51:32 -0400 |
| commit | a2d767558e21ea249597f7779270ebbe7914888d (patch) | |
| tree | a62672405a692ae2af93bf82a87698136ed1ee4c /docs/README.md | |
| parent | fix tbl (diff) | |
| download | comus-a2d767558e21ea249597f7779270ebbe7914888d.tar.gz comus-a2d767558e21ea249597f7779270ebbe7914888d.tar.bz2 comus-a2d767558e21ea249597f7779270ebbe7914888d.zip | |
add docstring stmt
Diffstat (limited to '')
| -rw-r--r-- | docs/README.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md index 3c4f052..c5c7158 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,6 +20,12 @@ amd64 Multiboot (Legacy / UEFI) +## Docstrings + +Kernel function docstrings MUST be located in the headers. + +Docstrings for global functions MAY be in the source c files. + ## Startup 1. Multiboot loads kernel into either `_start` or `_start_efi` |