Skip to content

Commit 4c188fb

Browse files
committed
rustdoc: Promote resource long descriptions to brief descriptions
1 parent 21fc2a3 commit 4c188fb

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

src/rustdoc/desc_to_brief_pass.rs

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ fn run(
2121
fold_mod: fold_mod,
2222
fold_const: fold_const,
2323
fold_fn: fold_fn,
24-
fold_enum: fold_enum
24+
fold_enum: fold_enum,
25+
fold_res: fold_res
2526
with *fold::default_seq_fold(())
2627
});
2728
fold.fold_crate(fold, doc)
@@ -71,6 +72,17 @@ fn fold_enum(fold: fold::fold<()>, doc: doc::enumdoc) -> doc::enumdoc {
7172
}
7273
}
7374

75+
fn fold_res(fold: fold::fold<()>, doc: doc::resdoc) -> doc::resdoc {
76+
let doc = fold::default_seq_fold_res(fold, doc);
77+
let (brief, desc) = modify(doc.brief, doc.desc);
78+
79+
~{
80+
brief: brief,
81+
desc: desc
82+
with *doc
83+
}
84+
}
85+
7486
#[test]
7587
fn should_promote_mod_desc() {
7688
let source = "#[doc(desc = \"desc\")] mod m { }";
@@ -115,6 +127,17 @@ fn should_promote_enum_desc() {
115127
assert doc.topmod.enums[0].desc == none;
116128
}
117129

130+
#[test]
131+
fn should_promote_resource_desc() {
132+
let source = "#[doc(desc = \"desc\")] resource r(a: bool) { }";
133+
let srv = astsrv::mk_srv_from_str(source);
134+
let doc = extract::from_srv(srv, "");
135+
let doc = attr_pass::mk_pass()(srv, doc);
136+
let doc = run(srv, doc);
137+
assert doc.topmod.resources[0].brief == some("desc");
138+
assert doc.topmod.resources[0].desc == none;
139+
}
140+
118141
fn modify(
119142
brief: option<str>,
120143
desc: option<str>

0 commit comments

Comments
 (0)