Updates to doc structures and using rustdoc format #266
Conversation
yashaswi2000
requested review from
rennergade,
JustinCappos,
ve1nard,
namanlalitnyu,
rupeshkoushik07,
davidge20 and
qianxichen233
| //! | ||
| //! Cages have methods for filesystem-related calls. They return a code or an error from the `errno` enum. | ||
| //! | ||
| //! - [open_syscall](crate::safeposix::cage::Cage::open_syscall) |
There was a problem hiding this comment.
Note, that Rustdoc will automatically create a list like this for you for each of the functions. I'm not sure you need to do this manually.
There was a problem hiding this comment.
So, the sys calls are implemented as part of Cage struct. and we implemented them in different modules for better maintainability. but rustdoc associates these functions to Cage struct and these modules turn up empty. so added these lists to redirect to the Cage docs.
There was a problem hiding this comment.
Okay, please make sure you indicate this in a comment in the code
There was a problem hiding this comment.
(By the way, you can look at fdtables, which has a similar issue but gets around it. This may change the visibility / import structure of the code though. I honestly, don't recall exactly how I did this.)
|
@JustinCappos Id love to get your approval on this one too before I merge it. |
Description
Reformatting documentation to follow rustdoc format. enabling us to move towards Rust crate style documentation, supporting auto doc generation.
will be adding general templates for documenting structs, functions, traits here - style guide
Following rustdoc book for overall guidance and rust docs conventions from microsoft opensource resources.
rustdoc book
templates
Fixes # (issue)
Type of change
How Has This Been Tested?
lind_project/tests/test_cases/test_a.clind_project/tests/test_cases/test_b.cChecklist: