toaruos
toaruos copied to clipboard
Improve code documentation, and maybe generate docs
During my hiatus from ToaruOS in late 2020/early 2021, and as part of developing Kuroko, I started adopting javadoc/doxygen-style code comments which are now well supported in Bim. Kuroko's web documentation is actually built from the code documentation with Doxygen at the moment.
When I restarted work on Misaka in April, I adopted that code style for comments in the kernel, but the coverage remains poor.
- Completely document the kernel, including all APIs that are expected to be reasonably stable for modules.
- Convert all heading comments to Javadoc/Doxygen format to align with the kernel.
- (Optional) Generate kernel and library documentation from the Doxygen comments.