diff options
| author | Brian Anderson <banderson@mozilla.com> | 2012-01-18 18:11:26 -0800 |
|---|---|---|
| committer | Brian Anderson <banderson@mozilla.com> | 2012-01-18 19:59:24 -0800 |
| commit | 5bbf72e11c1b0dd5cb53c5c65bf358cfd1ea5b0d (patch) | |
| tree | 61084c239e7d8680b625521145283efb07c749dc /src/rustdoc | |
| parent | 08da893cdb1c4533c9ecd2a3c443a4c98fd77530 (diff) | |
| download | rust-5bbf72e11c1b0dd5cb53c5c65bf358cfd1ea5b0d.tar.gz rust-5bbf72e11c1b0dd5cb53c5c65bf358cfd1ea5b0d.zip | |
rustdoc: Add brief and desc fields to module docs
Diffstat (limited to 'src/rustdoc')
| -rw-r--r-- | src/rustdoc/attr_pass.rs | 5 | ||||
| -rw-r--r-- | src/rustdoc/doc.rs | 2 | ||||
| -rw-r--r-- | src/rustdoc/extract.rs | 2 | ||||
| -rw-r--r-- | src/rustdoc/fold.rs | 2 | ||||
| -rwxr-xr-x | src/rustdoc/rustdoc.rs | 4 |
5 files changed, 11 insertions, 4 deletions
diff --git a/src/rustdoc/attr_pass.rs b/src/rustdoc/attr_pass.rs index 10fa5022a7a..40953f7aec7 100644 --- a/src/rustdoc/attr_pass.rs +++ b/src/rustdoc/attr_pass.rs @@ -52,9 +52,8 @@ fn fold_crate( ~{ topmod: ~{ - name: option::from_maybe(doc.topmod.name, attrs.name), - mods: doc.topmod.mods, - fns: doc.topmod.fns + name: option::from_maybe(doc.topmod.name, attrs.name) + with *doc.topmod } } } diff --git a/src/rustdoc/doc.rs b/src/rustdoc/doc.rs index 11a6702a7a6..c601cbfe365 100644 --- a/src/rustdoc/doc.rs +++ b/src/rustdoc/doc.rs @@ -8,6 +8,8 @@ type cratedoc = ~{ type moddoc = ~{ name: str, + brief: option<str>, + desc: option<str>, mods: modlist, fns: fnlist }; diff --git a/src/rustdoc/extract.rs b/src/rustdoc/extract.rs index 559c2fc47ab..3411432ce22 100644 --- a/src/rustdoc/extract.rs +++ b/src/rustdoc/extract.rs @@ -38,6 +38,8 @@ fn moddoc_from_mod( ) -> doc::moddoc { ~{ name: name, + brief: none, + desc: none, mods: doc::modlist( vec::filter_map(module.items) {|item| alt item.node { diff --git a/src/rustdoc/fold.rs b/src/rustdoc/fold.rs index 58b0724b29d..da6a4d35c3e 100644 --- a/src/rustdoc/fold.rs +++ b/src/rustdoc/fold.rs @@ -87,9 +87,9 @@ fn default_seq_fold_mod<T>( doc: doc::moddoc ) -> doc::moddoc { ~{ - name: doc.name, mods: fold.fold_modlist(fold, doc.mods), fns: fold.fold_fnlist(fold, doc.fns) + with *doc } } diff --git a/src/rustdoc/rustdoc.rs b/src/rustdoc/rustdoc.rs index 2abb6b4718b..ba58c490902 100755 --- a/src/rustdoc/rustdoc.rs +++ b/src/rustdoc/rustdoc.rs @@ -27,6 +27,8 @@ fn test_run_passes() { ~{ topmod: ~{ name: doc.topmod.name + "two", + brief: none, + desc: none, mods: doc::modlist([]), fns: doc::fnlist([]) } @@ -39,6 +41,8 @@ fn test_run_passes() { ~{ topmod: ~{ name: doc.topmod.name + "three", + brief: none, + desc: none, mods: doc::modlist([]), fns: doc::fnlist([]) } |
