Add rustdoc comments and doc macros to all existing code files
mdpatelcsecon opened this issue · comments
Add documentation comments and doc macros to all existing code files so documentation can be automatically generated from the source code using rustdoc.
What is Api trait in arch/mod.rs?
@ibaryshnikov That is the common interface used by the rest of the kernel to interact with ISA specific code.
@ibaryshnikov I added some doc comments myself and pushed them to main. You should rebase your branch on the latest main branch to get the changes.
This issue is open for anyone to grab and it should be relatively easy albeit maybe tedious.