about summary refs log tree commit diff
path: root/src/rustdoc/rustdoc.rs
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2012-01-18 23:11:20 -0800
committerBrian Anderson <banderson@mozilla.com>2012-01-18 23:11:20 -0800
commitca7cfbe3d0251766217e5d4e559903e655e7549b (patch)
tree11d7ae6e88d4d603c9fe59c958041ada95ca3d5b /src/rustdoc/rustdoc.rs
parentb141de657bb05653610a52d466f814f031cc26c1 (diff)
downloadrust-ca7cfbe3d0251766217e5d4e559903e655e7549b.tar.gz
rust-ca7cfbe3d0251766217e5d4e559903e655e7549b.zip
rustdoc: Add more rustdocs
Diffstat (limited to 'src/rustdoc/rustdoc.rs')
-rwxr-xr-xsrc/rustdoc/rustdoc.rs16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/rustdoc/rustdoc.rs b/src/rustdoc/rustdoc.rs
index b58850b7e3e..6406c2f1df0 100755
--- a/src/rustdoc/rustdoc.rs
+++ b/src/rustdoc/rustdoc.rs
@@ -11,7 +11,21 @@ fn run_passes(
     passes: [pass]
 ) -> doc::cratedoc {
 
-    #[doc = "Run a series of passes over the document"];
+    #[doc(
+        brief =
+        "Run a series of passes over the document",
+        args(
+            srv =
+            "The AST service to provide to the passes",
+            doc =
+            "The document to transform",
+            passes =
+            "The list of passes used to transform the document"
+        ),
+        return =
+        "The transformed document that results from folding the \
+         original through each pass"
+    )];
 
     vec::foldl(doc, passes) {|doc, pass|
         pass(srv, doc)