]> git.lizzy.rs Git - rust.git/commitdiff
Add doc comments describing fields on `externalfiles::ExternalHtml`.
authorCorey Farwell <coreyf@rwell.org>
Sat, 8 Oct 2016 21:34:13 +0000 (17:34 -0400)
committerCorey Farwell <coreyf@rwell.org>
Sun, 9 Oct 2016 02:55:51 +0000 (22:55 -0400)
src/librustdoc/externalfiles.rs

index 8b71c133ed48b3b2eba3da5426ae6fa8a473e853..7a6b414e79edbffa67f4ce75233b862feeb97d4f 100644 (file)
 
 #[derive(Clone)]
 pub struct ExternalHtml{
+    /// Content that will be included inline in the <head> section of a
+    /// rendered Markdown file or generated documentation
     pub in_header: String,
+    /// Content that will be included inline between <body> and the content of
+    /// a rendered Markdown file or generated documentation
     pub before_content: String,
+    /// Content that will be included inline between the content and </body> of
+    /// a rendered Markdown file or generated documentation
     pub after_content: String
 }