Skip to content

Commit 5bbf72e

Browse files
committed
rustdoc: Add brief and desc fields to module docs
1 parent 08da893 commit 5bbf72e

File tree

5 files changed

+11
-4
lines changed

5 files changed

+11
-4
lines changed

src/rustdoc/attr_pass.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,8 @@ fn fold_crate(
5252

5353
~{
5454
topmod: ~{
55-
name: option::from_maybe(doc.topmod.name, attrs.name),
56-
mods: doc.topmod.mods,
57-
fns: doc.topmod.fns
55+
name: option::from_maybe(doc.topmod.name, attrs.name)
56+
with *doc.topmod
5857
}
5958
}
6059
}

src/rustdoc/doc.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ type cratedoc = ~{
88

99
type moddoc = ~{
1010
name: str,
11+
brief: option<str>,
12+
desc: option<str>,
1113
mods: modlist,
1214
fns: fnlist
1315
};

src/rustdoc/extract.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ fn moddoc_from_mod(
3838
) -> doc::moddoc {
3939
~{
4040
name: name,
41+
brief: none,
42+
desc: none,
4143
mods: doc::modlist(
4244
vec::filter_map(module.items) {|item|
4345
alt item.node {

src/rustdoc/fold.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ fn default_seq_fold_mod<T>(
8787
doc: doc::moddoc
8888
) -> doc::moddoc {
8989
~{
90-
name: doc.name,
9190
mods: fold.fold_modlist(fold, doc.mods),
9291
fns: fold.fold_fnlist(fold, doc.fns)
92+
with *doc
9393
}
9494
}
9595

src/rustdoc/rustdoc.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ fn test_run_passes() {
2727
~{
2828
topmod: ~{
2929
name: doc.topmod.name + "two",
30+
brief: none,
31+
desc: none,
3032
mods: doc::modlist([]),
3133
fns: doc::fnlist([])
3234
}
@@ -39,6 +41,8 @@ fn test_run_passes() {
3941
~{
4042
topmod: ~{
4143
name: doc.topmod.name + "three",
44+
brief: none,
45+
desc: none,
4246
mods: doc::modlist([]),
4347
fns: doc::fnlist([])
4448
}

0 commit comments

Comments
 (0)