]> git.lizzy.rs Git - rust.git/commitdiff
rustdoc: Write markdown for mod description
authorBrian Anderson <banderson@mozilla.com>
Thu, 19 Jan 2012 05:33:37 +0000 (21:33 -0800)
committerBrian Anderson <banderson@mozilla.com>
Thu, 19 Jan 2012 05:33:37 +0000 (21:33 -0800)
src/rustdoc/gen.rs

index c3f0c99316968994b221a16fd0f91143cfe17631..2c3cb0ea9032bc6cfdd9484247a6e8a60f117fba 100644 (file)
@@ -71,21 +71,36 @@ fn write_mod(
 
 fn write_mod_contents(
     ctxt: ctxt,
-    moddoc: doc::moddoc
+    doc: doc::moddoc
 ) {
-    for fndoc in *moddoc.fns {
+    write_brief(ctxt, doc.brief);
+    write_desc(ctxt, doc.desc);
+
+    for fndoc in *doc.fns {
         subsection(ctxt) {||
             write_fn(ctxt, fndoc);
         }
     }
 
-    for moddoc in *moddoc.mods {
+    for moddoc in *doc.mods {
         subsection(ctxt) {||
             write_mod(ctxt, moddoc);
         }
     }
 }
 
+#[test]
+fn should_write_crate_brief_description() {
+    let markdown = test::render("#[doc(brief = \"this is the crate\")];");
+    assert str::contains(markdown, "this is the crate");
+}
+
+#[test]
+fn should_write_crate_description() {
+    let markdown = test::render("#[doc = \"this is the crate\"];");
+    assert str::contains(markdown, "this is the crate");
+}
+
 fn write_fn(
     ctxt: ctxt,
     doc: doc::fndoc