doc: Document the documentation config entry.
This commit is contained in:
committed by
Emilio Cobos Álvarez
parent
d0d287f9f3
commit
d3cd22bc6f
@@ -481,6 +481,9 @@ line_length = 80
|
||||
# default: 2
|
||||
tab_width = 3
|
||||
|
||||
# Include doc comments from Rust as documentation
|
||||
documentation = true
|
||||
|
||||
# How the generated documentation should be commented.
|
||||
#
|
||||
# possible values:
|
||||
|
||||
@@ -930,7 +930,7 @@ pub struct Config {
|
||||
pub constant: ConstantConfig,
|
||||
/// Preprocessor defines to use when generating #ifdef's for #[cfg]
|
||||
pub defines: HashMap<String, String>,
|
||||
/// Include doc comments from rust as documentation
|
||||
/// Include doc comments from Rust as documentation
|
||||
pub documentation: bool,
|
||||
/// How documentation comments should be styled.
|
||||
pub documentation_style: DocumentationStyle,
|
||||
|
||||
@@ -34,6 +34,7 @@ after_includes = ""
|
||||
braces = "SameLine"
|
||||
line_length = 100
|
||||
tab_width = 2
|
||||
documentation = true
|
||||
documentation_style = "auto"
|
||||
line_endings = "LF" # also "CR", "CRLF", "Native"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user