about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2012-01-17 23:29:23 -0800
committerBrian Anderson <banderson@mozilla.com>2012-01-17 23:29:23 -0800
commit0142e807ddd4059e3d4d2c0dd4b5aa13eab3c19a (patch)
treefa11a91729edfe132724fbca6443234c3c7d75ac /src
parent971236e8f7ecca4612c7aa0cd94d78c8b24187f8 (diff)
downloadrust-0142e807ddd4059e3d4d2c0dd4b5aa13eab3c19a.tar.gz
rust-0142e807ddd4059e3d4d2c0dd4b5aa13eab3c19a.zip
rustdoc: Write blank lines after brief descriptions
Diffstat (limited to 'src')
-rw-r--r--src/rustdoc/gen.rs25
1 files changed, 23 insertions, 2 deletions
diff --git a/src/rustdoc/gen.rs b/src/rustdoc/gen.rs
index 8f1b3b50d82..41b505c31bd 100644
--- a/src/rustdoc/gen.rs
+++ b/src/rustdoc/gen.rs
@@ -94,6 +94,7 @@ fn write_fn(
     alt doc.brief {
       some(brief) {
         ctxt.w.write_line(brief);
+        ctxt.w.write_line("");
       }
       none. { }
     }
@@ -145,7 +146,7 @@ mod tests {
         let ast = parse::from_str(source);
         let doc = extract::extract(ast, "belch");
         let markdown = write_markdown_str(doc);
-        assert str::contains(markdown, "# Crate belch\n");
+        assert str::contains(markdown, "# Crate belch");
     }
 
     #[test]
@@ -172,6 +173,26 @@ mod tests {
         let ast = parse::from_str(source);
         let doc = extract::extract(ast, "");
         let markdown = write_markdown_str(doc);
-        assert str::contains(markdown, "Module `morp`\n");
+        assert str::contains(markdown, "Module `morp`\n\n");
+    }
+
+    #[test]
+    fn should_leave_blank_line_between_fn_header_and_brief() {
+        let source = "#[doc(brief = \"brief\")] fn a() { }";
+        let srv = astsrv::mk_srv_from_str(source);
+        let doc = extract::from_srv(srv, "");
+        let doc = attr_pass::mk_pass()(srv, doc);
+        let markdown = write_markdown_str(doc);
+        assert str::contains(markdown, "Function `a`\n\nbrief");
+    }
+
+    #[test]
+    fn should_leve_blank_line_after_brief() {
+        let source = "#[doc(brief = \"brief\")] fn a() { }";
+        let srv = astsrv::mk_srv_from_str(source);
+        let doc = extract::from_srv(srv, "");
+        let doc = attr_pass::mk_pass()(srv, doc);
+        let markdown = write_markdown_str(doc);
+        assert str::contains(markdown, "brief\n\n");
     }
 }
\ No newline at end of file