]> git.lizzy.rs Git - rust.git/commitdiff
rustdoc: Add more rustdocs
authorBrian Anderson <banderson@mozilla.com>
Thu, 19 Jan 2012 07:11:20 +0000 (23:11 -0800)
committerBrian Anderson <banderson@mozilla.com>
Thu, 19 Jan 2012 07:11:20 +0000 (23:11 -0800)
src/rustdoc/rustdoc.rs

index b58850b7e3ec32c2fd1d88eb1be856c40270e452..6406c2f1df026f86899ed54bca47863a9ef31b07 100755 (executable)
@@ -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)