about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2012-01-23 16:17:46 -0800
committerBrian Anderson <banderson@mozilla.com>2012-01-23 16:18:01 -0800
commitf4c31bda62dd42d6d7990a2e56821eff12099bf7 (patch)
tree3bc227ac73fec016755578f6206df8509127aad0
parentfa3368bc71611f071489a3a5183bd572bc6f4022 (diff)
downloadrust-f4c31bda62dd42d6d7990a2e56821eff12099bf7.tar.gz
rust-f4c31bda62dd42d6d7990a2e56821eff12099bf7.zip
rustdoc: Print return value descriptions on same line as type
-rw-r--r--src/rustdoc/gen.rs18
1 files changed, 14 insertions, 4 deletions
diff --git a/src/rustdoc/gen.rs b/src/rustdoc/gen.rs
index a4b9528cfeb..c757fc670e2 100644
--- a/src/rustdoc/gen.rs
+++ b/src/rustdoc/gen.rs
@@ -226,14 +226,16 @@ fn write_return(
 ) {
     alt doc.ty {
       some(ty) {
-        ctxt.w.write_line(#fmt("Returns `%s`", ty));
-        ctxt.w.write_line("");
+        ctxt.w.write_str(#fmt("Returns `%s`", ty));
         alt doc.desc {
           some(d) {
-            ctxt.w.write_line(d);
+            ctxt.w.write_line(#fmt(" - %s", d));
+            ctxt.w.write_line("");
+          }
+          none {
+            ctxt.w.write_line("");
             ctxt.w.write_line("");
           }
-          none { }
         }
       }
       none { }
@@ -269,6 +271,14 @@ fn should_write_blank_line_after_return_description() {
     assert str::contains(markdown, "blorp\n\n");
 }
 
+#[test]
+fn should_write_return_description_on_same_line_as_type() {
+    let markdown = test::render(
+        "#[doc(return = \"blorp\")] fn a() -> int { }"
+    );
+    assert str::contains(markdown, "Returns `int` - blorp");
+}
+
 #[cfg(test)]
 mod test {
     fn render(source: str) -> str {