doc: Document the documentation config entry.

mozilla · Feb 1, 2021 · d3cd22b · d3cd22b
1 parent d0d287f
commit d3cd22b
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/docs.md b/docs.md
@@ -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:

diff --git a/src/bindgen/config.rs b/src/bindgen/config.rs
@@ -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,

diff --git a/template.toml b/template.toml
@@ -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"