]> git.lizzy.rs Git - rust.git/commitdiff
rustdoc: Introduce type doc::argdoc
authorBrian Anderson <banderson@mozilla.com>
Wed, 18 Jan 2012 22:47:18 +0000 (14:47 -0800)
committerBrian Anderson <banderson@mozilla.com>
Wed, 18 Jan 2012 23:02:43 +0000 (15:02 -0800)
src/rustdoc/attr_pass.rs
src/rustdoc/doc.rs
src/rustdoc/extract.rs
src/rustdoc/gen.rs

index 2daa77fac57dc637c407d3bfe403a0c9a97ecad0..10fa5022a7a62dbb4b0a215d80a57f5c68792c75 100644 (file)
@@ -99,9 +99,9 @@ fn merge_fn_attrs(
     }
 
     fn merge_arg_attrs(
-        doc: [(str, str)],
+        doc: [doc::argdoc],
         _attrs: [attr_parser::arg_attrs]
-    ) -> [(str, str)] {
+    ) -> [doc::argdoc] {
         // FIXME
         doc
     }
index 8fb3c6bc53ec70202924aef213fcba66ab6c3f08..2b5856e0facae03fd0ad406d26cfc9d18f1f2ceb 100644 (file)
     brief: option<str>,
     desc: option<str>,
     return: option<retdoc>,
-    args: [(str, str)]
+    args: [argdoc]
+};
+
+type argdoc = ~{
+    name: str
 };
 
 type retdoc = {
index cb6feb98d58a6fe06fd5302f10124a22db5d088c..3b5a2e0912745ba5e4a0ed278507eaf927423412 100644 (file)
@@ -85,16 +85,18 @@ fn should_extract_fn_args() {
     let ast = parse::from_str(source);
     let doc = extract(ast, "");
     let fn_ = doc.topmod.fns[0];
-    assert tuple::first(fn_.args[0]) == "b";
-    assert tuple::first(fn_.args[1]) == "c";
+    assert fn_.args[0].name == "b";
+    assert fn_.args[1].name == "c";
 }
 
-fn argdocs_from_args(args: [ast::arg]) -> [(str, str)] {
+fn argdocs_from_args(args: [ast::arg]) -> [doc::argdoc] {
     vec::map(args, argdoc_from_arg)
 }
 
-fn argdoc_from_arg(arg: ast::arg) -> (str, str) {
-    (arg.ident, "")
+fn argdoc_from_arg(arg: ast::arg) -> doc::argdoc {
+    ~{
+        name: arg.ident
+    }
 }
 
 #[cfg(test)]
index afd06523b9a88edf27372a23f30c27d106e524d4..ee555962e29dfee28b06fa0e7f01d6dba939f191 100644 (file)
@@ -125,11 +125,10 @@ fn write_desc(
 
 fn write_args(
     ctxt: ctxt,
-    args: [(str, str)]
+    args: [doc::argdoc]
 ) {
-    for (arg, desc) in args {
-        ctxt.w.write_str("### Argument `" + arg + "`: ");
-        ctxt.w.write_str(desc)
+    for arg in args {
+        ctxt.w.write_str("### Argument `" + arg.name + "`: ");
     }
 }