rustdoc: Remove non-attribute related stuff from attr_parser
This commit is contained in:
parent
c87b820298
commit
d455d46b15
1 changed files with 60 additions and 76 deletions
|
@ -1,67 +1,52 @@
|
||||||
import rustc::syntax::ast;
|
import rustc::syntax::ast;
|
||||||
|
|
||||||
|
export fn_attrs, arg_attrs;
|
||||||
export parse_fn;
|
export parse_fn;
|
||||||
|
|
||||||
fn parse_fn(
|
type fn_attrs = {
|
||||||
|
brief: option<str>,
|
||||||
|
desc: option<str>,
|
||||||
|
args: [arg_attrs],
|
||||||
|
return: option<str>
|
||||||
|
};
|
||||||
|
|
||||||
|
type arg_attrs = {
|
||||||
name: str,
|
name: str,
|
||||||
id: ast::node_id,
|
desc: str
|
||||||
|
};
|
||||||
|
|
||||||
|
fn parse_fn(
|
||||||
attrs: [ast::attribute]
|
attrs: [ast::attribute]
|
||||||
) -> doc::fndoc {
|
) -> fn_attrs {
|
||||||
let _fndoc = none;
|
|
||||||
for attr: ast::attribute in attrs {
|
for attr in attrs {
|
||||||
alt attr.node.value.node {
|
alt attr.node.value.node {
|
||||||
ast::meta_name_value(
|
ast::meta_name_value(
|
||||||
"doc", {node: ast::lit_str(value), span: _}) {
|
"doc", {node: ast::lit_str(value), span: _}) {
|
||||||
_fndoc = some(~{
|
ret {
|
||||||
id: id,
|
brief: none,
|
||||||
name: name,
|
desc: some(value),
|
||||||
brief: some(value),
|
args: [],
|
||||||
desc: none,
|
return: none
|
||||||
return: none,
|
};
|
||||||
args: []
|
}
|
||||||
});
|
ast::meta_list("doc", docs) {
|
||||||
}
|
ret parse_fn_(docs);
|
||||||
ast::meta_list("doc", docs) {
|
}
|
||||||
_fndoc = some(
|
|
||||||
parse_fn_(name, id, docs));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
let _fndoc0 = alt _fndoc {
|
{
|
||||||
some(_d) { _d }
|
brief: none,
|
||||||
none. {
|
desc: none,
|
||||||
~{
|
args: [],
|
||||||
id: id,
|
return: none
|
||||||
name: name,
|
}
|
||||||
brief: none,
|
|
||||||
desc: none,
|
|
||||||
return: none,
|
|
||||||
args: []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
ret _fndoc0;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[doc(
|
|
||||||
brief = "Parses function docs from a complex #[doc] attribute.",
|
|
||||||
desc = "Supported attributes:
|
|
||||||
|
|
||||||
* `brief`: Brief description
|
|
||||||
* `desc`: Long description
|
|
||||||
* `return`: Description of return value
|
|
||||||
* `args`: List of argname = argdesc pairs
|
|
||||||
",
|
|
||||||
args(items = "Doc attribute contents"),
|
|
||||||
return = "Parsed function docs."
|
|
||||||
)]
|
|
||||||
fn parse_fn_(
|
fn parse_fn_(
|
||||||
name: str,
|
|
||||||
id: ast::node_id,
|
|
||||||
items: [@ast::meta_item]
|
items: [@ast::meta_item]
|
||||||
) -> doc::fndoc {
|
) -> fn_attrs {
|
||||||
let brief = none;
|
let brief = none;
|
||||||
let desc = none;
|
let desc = none;
|
||||||
let return = none;
|
let return = none;
|
||||||
|
@ -95,23 +80,22 @@ fn parse_fn_(
|
||||||
alt d.node {
|
alt d.node {
|
||||||
ast::meta_name_value(key, {node: ast::lit_str(value),
|
ast::meta_name_value(key, {node: ast::lit_str(value),
|
||||||
span: _}) {
|
span: _}) {
|
||||||
argdocs += [(key, value)];
|
argdocs += [{
|
||||||
|
name: key,
|
||||||
|
desc: value
|
||||||
|
}];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
~{
|
{
|
||||||
id: id,
|
|
||||||
name: name,
|
|
||||||
brief: brief,
|
brief: brief,
|
||||||
desc: desc,
|
desc: desc,
|
||||||
return: some({
|
args: argdocs,
|
||||||
desc: return,
|
return: return
|
||||||
ty: none,
|
}
|
||||||
}),
|
|
||||||
args: argdocs }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
|
@ -138,51 +122,51 @@ mod tests {
|
||||||
fn parse_fn_should_handle_undocumented_functions() {
|
fn parse_fn_should_handle_undocumented_functions() {
|
||||||
let source = "";
|
let source = "";
|
||||||
let attrs = parse_attributes(source);
|
let attrs = parse_attributes(source);
|
||||||
let doc = parse_fn("f", 0, attrs);
|
let attrs = parse_fn(attrs);
|
||||||
assert doc.brief == none;
|
assert attrs.brief == none;
|
||||||
assert doc.desc == none;
|
assert attrs.desc == none;
|
||||||
assert doc.return == none;
|
assert attrs.return == none;
|
||||||
assert vec::len(doc.args) == 0u;
|
assert vec::len(attrs.args) == 0u;
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tes]
|
||||||
fn parse_fn_should_parse_simple_doc_attributes() {
|
fn parse_fn_should_parse_simple_doc_attributes() {
|
||||||
let source = "#[doc = \"basic\"]";
|
let source = "#[doc = \"basic\"]";
|
||||||
let attrs = parse_attributes(source);
|
let attrs = parse_attributes(source);
|
||||||
let doc = parse_fn("f", 0, attrs);
|
let attrs = parse_fn(attrs);
|
||||||
assert doc.brief == some("basic");
|
assert attrs.brief == some("basic");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn parse_fn_should_parse_the_brief_description() {
|
fn parse_fn_should_parse_the_brief_description() {
|
||||||
let source = "#[doc(brief = \"short\")]";
|
let source = "#[doc(brief = \"short\")]";
|
||||||
let attrs = parse_attributes(source);
|
let attrs = parse_attributes(source);
|
||||||
let doc = parse_fn("f", 0, attrs);
|
let attrs = parse_fn(attrs);
|
||||||
assert doc.brief == some("short");
|
assert attrs.brief == some("short");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn parse_fn_should_parse_the_long_description() {
|
fn parse_fn_should_parse_the_long_description() {
|
||||||
let source = "#[doc(desc = \"description\")]";
|
let source = "#[doc(desc = \"description\")]";
|
||||||
let attrs = parse_attributes(source);
|
let attrs = parse_attributes(source);
|
||||||
let doc = parse_fn("f", 0, attrs);
|
let attrs = parse_fn(attrs);
|
||||||
assert doc.desc == some("description");
|
assert attrs.desc == some("description");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn parse_fn_should_parse_the_return_value_description() {
|
fn parse_fn_should_parse_the_return_value_description() {
|
||||||
let source = "#[doc(return = \"return value\")]";
|
let source = "#[doc(return = \"return value\")]";
|
||||||
let attrs = parse_attributes(source);
|
let attrs = parse_attributes(source);
|
||||||
let doc = parse_fn("f", 0, attrs);
|
let attrs = parse_fn(attrs);
|
||||||
assert option::get(doc.return).desc == some("return value");
|
assert attrs.return == some("return value");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn parse_fn_should_parse_the_argument_descriptions() {
|
fn parse_fn_should_parse_the_argument_descriptions() {
|
||||||
let source = "#[doc(args(a = \"arg a\", b = \"arg b\"))]";
|
let source = "#[doc(args(a = \"arg a\", b = \"arg b\"))]";
|
||||||
let attrs = parse_attributes(source);
|
let attrs = parse_attributes(source);
|
||||||
let doc = parse_fn("f", 0, attrs);
|
let attrs = parse_fn(attrs);
|
||||||
assert doc.args[0] == ("a", "arg a");
|
assert attrs.args[0] == {name: "a", desc: "arg a"};
|
||||||
assert doc.args[1] == ("b", "arg b");
|
assert attrs.args[1] == {name: "b", desc: "arg b"};
|
||||||
}
|
}
|
||||||
}
|
}
|
Loading…
Add table
Add a link
Reference in a new issue