Every crate should compile with deny(missing_docs) on

[hawkw]

I'd really like to be able to say I have 100% comprehensive documentation for every publicly-exposed symbol in the SOS source code.

Rust gives us the #[deny(missing_docs)] attribute, which will fail compilation if it hits an item without documentation comments. I'd really like to say that the kernel can compile with this attribute enabled.

This is, however, a big project. There's a lot of code here, and the quality of documentation varies a lot module by module. Therefore, I might make separate issues for each crate and maybe turn this into a project/milestone.

• alloc crate compiles with deny(missing_docs)
• boot crate compiles with deny(missing_docs)
• cpu crate compiles with deny(missing_docs)
• elf crate compiles with deny(missing_docs)
• memory crate compiles with deny(missing_docs)
• sos_intrusive crate compiles with deny(missing_docs)
• util crate compiles with deny(missing_docs)
• vga crate compiles with deny(missing_docs)
• core kernel compiles with deny(missing_docs)

[hawkw]

This is something that I'm totally open to assistance with. This might actually be a good way for a newcomer to start familiarising themselves with what's going on here, without having to actually write new code.

If anybody (@rachlmac maybe?) is interested in learning more about how the kernel works, I'd be happy to provide you with informal explanations of undocumented code, which you could start turning into more formal documentation comments.

(sidenote: if anybody else cares about this sort of thing, it would also give you a way to contribute lots of lines to the project real quick, which would look nice on your GitHub profile! :D )