OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

rustdoc: Write fn arg descriptions to markdown

Browse Source
This commit is contained in:
Brian Anderson 2012-01-18 22:40:06 -08:00
parent 266cc7b0c3
commit fb82e6ab79
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/rustdoc/gen.rs
View File

@ -152,11 +152,18 @@ fn write_args(
fn write_arg(ctxt: ctxt, arg: doc::argdoc) {
assert option::is_some(arg.ty);
ctxt.w.write_line(#fmt(
ctxt.w.write_str(#fmt(
"* `%s`: `%s`",
arg.name,
option::get(arg.ty)
));
alt arg.desc {
some(desc) {
ctxt.w.write_str(#fmt(" - %s", desc));
}
none. { }
}
ctxt.w.write_line("");
}
#[test]
@ -180,6 +187,13 @@ fn should_not_write_arguments_if_none() {
assert !str::contains(markdown, "Arguments");
}
#[test]
fn should_write_argument_description() {
let source = "#[doc(args(a = \"milk\"))] fn f(a: bool) { }";
let markdown = test::render(source);
assert str::contains(markdown, "`a`: `bool` - milk");
}
fn write_return(
ctxt: ctxt,
return: option<doc::retdoc>