Add API documentation guidelines in to-contribute

This commit is contained in:
Jianfeng Jiang
2024-05-27 02:47:43 +00:00
committed by Tate, Hongliang Tian
parent f581ebdd03
commit 5687f23b56
4 changed files with 17 additions and 4 deletions

View File

@ -38,7 +38,7 @@
* [Code Organization]()
* [Style Guidelines]()
* [General Guidelines]()
* [Rust Guidelines]()
* [Rust Guidelines](to-contribute/style-guidelines/rust-guidelines.md)
* [Git Guidelines]()
* [Community]()
* [Code of Conduct]()

View File

@ -1 +1 @@
# General Guidlines
# General Guidelines

View File

@ -1 +1 @@
# Commit Guidlines
# Commit Guidelines

View File

@ -1 +1,14 @@
# Rust Guidlines
# Rust Guidelines
## API Documentation Guidelines
API documentation describes the meanings and usage of APIs,
and will be rendered into web pages by rustdoc.
It is necessary to add documentation to all public APIs,
including crates, modules, structs, traits, functions, macros, and more.
The use of the `#[warn(missing_docs)]` lint enforces this rule.
Asterinas adheres to the API style guidelines of the Rust community.
The recommended API documentation style can be found at
[how-to-write-documentation](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html).