mirror of
https://github.com/asterinas/asterinas.git
synced 2025-06-21 08:26:30 +00:00
Add API documentation guidelines in to-contribute
This commit is contained in:
committed by
Tate, Hongliang Tian
parent
f581ebdd03
commit
5687f23b56
@ -38,7 +38,7 @@
|
|||||||
* [Code Organization]()
|
* [Code Organization]()
|
||||||
* [Style Guidelines]()
|
* [Style Guidelines]()
|
||||||
* [General Guidelines]()
|
* [General Guidelines]()
|
||||||
* [Rust Guidelines]()
|
* [Rust Guidelines](to-contribute/style-guidelines/rust-guidelines.md)
|
||||||
* [Git Guidelines]()
|
* [Git Guidelines]()
|
||||||
* [Community]()
|
* [Community]()
|
||||||
* [Code of Conduct]()
|
* [Code of Conduct]()
|
||||||
|
@ -1 +1 @@
|
|||||||
# General Guidlines
|
# General Guidelines
|
||||||
|
@ -1 +1 @@
|
|||||||
# Commit Guidlines
|
# Commit Guidelines
|
||||||
|
@ -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).
|
||||||
|
Reference in New Issue
Block a user