rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

rustdoc: Put brief descriptions in the indexes

Browse Source
This commit is contained in:
Brian Anderson
2012-03-06 16:51:40 -08:00
parent a4ff220133
commit 29ac3c811d
3 changed files with 29 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/rustdoc/markdown_pass.rs
View File

@@ -283,7 +283,12 @@ fn write_index(ctxt: ctxt, index: doc::index) {
for entry in index.entries {
let header = header_text_(entry.kind, entry.name);
let id = entry.link;
ctxt.w.write_line(#fmt("* [%s](%s)", header, id));
if option::is_some(entry.brief) {
ctxt.w.write_line(#fmt("* [%s](%s) - %s",
header, id, option::get(entry.brief)));
} else {
ctxt.w.write_line(#fmt("* [%s](%s)", header, id));
}
}
ctxt.w.write_line("");
}
@@ -298,6 +303,12 @@ fn should_write_index() {
);
}
#[test]
fn should_write_index_brief() {
let markdown = test::render("#[doc(brief = \"test\")] mod a { }");
assert str::contains(markdown, "(#module-a) - test\n");
}
#[test]
fn should_not_write_index_if_no_entries() {
let markdown = test::render("");