rustdoc: Add brief and desc fields to module docs

This commit is contained in:
Brian Anderson
2012-01-18 18:11:26 -08:00
parent 08da893cdb
commit 5bbf72e11c
5 changed files with 11 additions and 4 deletions

View File

@@ -52,9 +52,8 @@ fn fold_crate(
~{ ~{
topmod: ~{ topmod: ~{
name: option::from_maybe(doc.topmod.name, attrs.name), name: option::from_maybe(doc.topmod.name, attrs.name)
mods: doc.topmod.mods, with *doc.topmod
fns: doc.topmod.fns
} }
} }
} }

View File

@@ -8,6 +8,8 @@ type cratedoc = ~{
type moddoc = ~{ type moddoc = ~{
name: str, name: str,
brief: option<str>,
desc: option<str>,
mods: modlist, mods: modlist,
fns: fnlist fns: fnlist
}; };

View File

@@ -38,6 +38,8 @@ fn moddoc_from_mod(
) -> doc::moddoc { ) -> doc::moddoc {
~{ ~{
name: name, name: name,
brief: none,
desc: none,
mods: doc::modlist( mods: doc::modlist(
vec::filter_map(module.items) {|item| vec::filter_map(module.items) {|item|
alt item.node { alt item.node {

View File

@@ -87,9 +87,9 @@ fn default_seq_fold_mod<T>(
doc: doc::moddoc doc: doc::moddoc
) -> doc::moddoc { ) -> doc::moddoc {
~{ ~{
name: doc.name,
mods: fold.fold_modlist(fold, doc.mods), mods: fold.fold_modlist(fold, doc.mods),
fns: fold.fold_fnlist(fold, doc.fns) fns: fold.fold_fnlist(fold, doc.fns)
with *doc
} }
} }

View File

@@ -27,6 +27,8 @@ fn test_run_passes() {
~{ ~{
topmod: ~{ topmod: ~{
name: doc.topmod.name + "two", name: doc.topmod.name + "two",
brief: none,
desc: none,
mods: doc::modlist([]), mods: doc::modlist([]),
fns: doc::fnlist([]) fns: doc::fnlist([])
} }
@@ -39,6 +41,8 @@ fn test_run_passes() {
~{ ~{
topmod: ~{ topmod: ~{
name: doc.topmod.name + "three", name: doc.topmod.name + "three",
brief: none,
desc: none,
mods: doc::modlist([]), mods: doc::modlist([]),
fns: doc::fnlist([]) fns: doc::fnlist([])
} }