1
Fork 0

rustdoc: Add function signatures to the doc tree

This commit is contained in:
Brian Anderson 2012-01-19 18:09:19 -08:00
parent 991db34b5b
commit 2a442f9f8f
4 changed files with 30 additions and 6 deletions

View file

@ -135,7 +135,7 @@ fn fold_fn(
desc: attrs.desc, desc: attrs.desc,
args: merge_arg_attrs(doc.args, attrs.args), args: merge_arg_attrs(doc.args, attrs.args),
return: merge_ret_attrs(doc.return, attrs.return), return: merge_ret_attrs(doc.return, attrs.return),
ty: none sig: none
}; };
} }

View file

@ -23,7 +23,7 @@ type fndoc = ~{
desc: option<str>, desc: option<str>,
args: [argdoc], args: [argdoc],
return: option<retdoc>, return: option<retdoc>,
ty: option<str> sig: option<str>
}; };
type argdoc = ~{ type argdoc = ~{

View file

@ -81,7 +81,7 @@ fn fndoc_from_fn(
desc: none, desc: none,
args: argdocs_from_args(decl.inputs), args: argdocs_from_args(decl.inputs),
return: none, return: none,
ty: none sig: none
} }
} }

View file

@ -30,12 +30,36 @@ fn fold_fn(
let srv = fold.ctxt; let srv = fold.ctxt;
~{ ~{
args: merge_arg_tys(srv, doc.id, doc.args),
return: merge_ret_ty(srv, doc.id, doc.return), return: merge_ret_ty(srv, doc.id, doc.return),
args: merge_arg_tys(srv, doc.id, doc.args) sig: get_fn_sig(srv, doc.id)
with *doc with *doc
} }
} }
fn get_fn_sig(srv: astsrv::srv, fn_id: doc::ast_id) -> option<str> {
astsrv::exec(srv) {|ctxt|
alt ctxt.map.get(fn_id) {
ast_map::node_item(@{
ident: ident,
node: ast::item_fn(decl, _, blk), _
}) {
some(pprust::fun_to_str(decl, ident, []))
}
}
}
}
#[test]
fn should_add_fn_sig() {
let source = "fn a() -> int { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let doc = run(srv, doc);
log(error, doc.topmod.fns[0].sig);
assert doc.topmod.fns[0].sig == some("fn a() -> int");
}
fn merge_ret_ty( fn merge_ret_ty(
srv: astsrv::srv, srv: astsrv::srv,
fn_id: doc::ast_id, fn_id: doc::ast_id,
@ -59,9 +83,9 @@ fn merge_ret_ty(
} }
} }
fn get_ret_ty(srv: astsrv::srv, id: doc::ast_id) -> option<str> { fn get_ret_ty(srv: astsrv::srv, fn_id: doc::ast_id) -> option<str> {
astsrv::exec(srv) {|ctxt| astsrv::exec(srv) {|ctxt|
alt ctxt.map.get(id) { alt ctxt.map.get(fn_id) {
ast_map::node_item(@{ ast_map::node_item(@{
node: ast::item_fn(decl, _, _), _ node: ast::item_fn(decl, _, _), _
}) { }) {