From a02a943cec35618b7fae32d9fd0f396566dc0635 Mon Sep 17 00:00:00 2001
From: Brian Anderson <banderson@mozilla.com>
Date: Wed, 18 Jan 2012 21:33:37 -0800
Subject: [PATCH] rustdoc: Write markdown for mod description

---
 src/rustdoc/gen.rs | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/src/rustdoc/gen.rs b/src/rustdoc/gen.rs
index c3f0c993169..2c3cb0ea903 100644
--- a/src/rustdoc/gen.rs
+++ b/src/rustdoc/gen.rs
@@ -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