rustdoc: Add definition of iface docs
This commit is contained in:
@@ -11,7 +11,8 @@ enum itemtag {
|
|||||||
consttag(constdoc),
|
consttag(constdoc),
|
||||||
fntag(fndoc),
|
fntag(fndoc),
|
||||||
enumtag(enumdoc),
|
enumtag(enumdoc),
|
||||||
restag(resdoc)
|
restag(resdoc),
|
||||||
|
ifacetag(ifacedoc)
|
||||||
}
|
}
|
||||||
|
|
||||||
type moddoc = {
|
type moddoc = {
|
||||||
@@ -77,6 +78,24 @@ type resdoc = {
|
|||||||
sig: option<str>
|
sig: option<str>
|
||||||
};
|
};
|
||||||
|
|
||||||
|
type ifacedoc = {
|
||||||
|
id: ast_id,
|
||||||
|
name: str,
|
||||||
|
brief: option<str>,
|
||||||
|
desc: option<str>,
|
||||||
|
methods: [methoddoc]
|
||||||
|
};
|
||||||
|
|
||||||
|
type methoddoc = {
|
||||||
|
name: str,
|
||||||
|
brief: option<str>,
|
||||||
|
desc: option<str>,
|
||||||
|
args: [argdoc],
|
||||||
|
return: retdoc,
|
||||||
|
failure: option<str>,
|
||||||
|
sig: option<str>
|
||||||
|
};
|
||||||
|
|
||||||
impl util for moddoc {
|
impl util for moddoc {
|
||||||
|
|
||||||
fn mods() -> [moddoc] {
|
fn mods() -> [moddoc] {
|
||||||
@@ -123,6 +142,15 @@ impl util for moddoc {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn ifaces() -> [ifacedoc] {
|
||||||
|
vec::filter_map(*self.items) {|itemtag|
|
||||||
|
alt itemtag {
|
||||||
|
ifacetag(ifacedoc) { some(ifacedoc) }
|
||||||
|
_ { none }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl util for itemtag {
|
impl util for itemtag {
|
||||||
@@ -133,6 +161,7 @@ impl util for itemtag {
|
|||||||
doc::consttag({name, _}) { name }
|
doc::consttag({name, _}) { name }
|
||||||
doc::enumtag({name, _}) { name }
|
doc::enumtag({name, _}) { name }
|
||||||
doc::restag({name, _}) { name }
|
doc::restag({name, _}) { name }
|
||||||
|
doc::ifacetag({name, _}) { name }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ export default_seq_fold_fn;
|
|||||||
export default_seq_fold_const;
|
export default_seq_fold_const;
|
||||||
export default_seq_fold_enum;
|
export default_seq_fold_enum;
|
||||||
export default_seq_fold_res;
|
export default_seq_fold_res;
|
||||||
|
export default_seq_fold_iface;
|
||||||
|
|
||||||
enum fold<T> = t<T>;
|
enum fold<T> = t<T>;
|
||||||
|
|
||||||
@@ -19,6 +20,7 @@ type fold_fn<T> = fn~(fold: fold<T>, doc: doc::fndoc) -> doc::fndoc;
|
|||||||
type fold_const<T> = fn~(fold: fold<T>, doc: doc::constdoc) -> doc::constdoc;
|
type fold_const<T> = fn~(fold: fold<T>, doc: doc::constdoc) -> doc::constdoc;
|
||||||
type fold_enum<T> = fn~(fold: fold<T>, doc: doc::enumdoc) -> doc::enumdoc;
|
type fold_enum<T> = fn~(fold: fold<T>, doc: doc::enumdoc) -> doc::enumdoc;
|
||||||
type fold_res<T> = fn~(fold: fold<T>, doc: doc::resdoc) -> doc::resdoc;
|
type fold_res<T> = fn~(fold: fold<T>, doc: doc::resdoc) -> doc::resdoc;
|
||||||
|
type fold_iface<T> = fn~(fold: fold<T>, doc: doc::ifacedoc) -> doc::ifacedoc;
|
||||||
|
|
||||||
type t<T> = {
|
type t<T> = {
|
||||||
ctxt: T,
|
ctxt: T,
|
||||||
@@ -27,7 +29,8 @@ type t<T> = {
|
|||||||
fold_fn: fold_fn<T>,
|
fold_fn: fold_fn<T>,
|
||||||
fold_const: fold_const<T>,
|
fold_const: fold_const<T>,
|
||||||
fold_enum: fold_enum<T>,
|
fold_enum: fold_enum<T>,
|
||||||
fold_res: fold_res<T>
|
fold_res: fold_res<T>,
|
||||||
|
fold_iface: fold_iface<T>
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
@@ -40,7 +43,8 @@ fn mk_fold<T:copy>(
|
|||||||
fold_fn: fold_fn<T>,
|
fold_fn: fold_fn<T>,
|
||||||
fold_const: fold_const<T>,
|
fold_const: fold_const<T>,
|
||||||
fold_enum: fold_enum<T>,
|
fold_enum: fold_enum<T>,
|
||||||
fold_res: fold_res<T>
|
fold_res: fold_res<T>,
|
||||||
|
fold_iface: fold_iface<T>
|
||||||
) -> fold<T> {
|
) -> fold<T> {
|
||||||
fold({
|
fold({
|
||||||
ctxt: ctxt,
|
ctxt: ctxt,
|
||||||
@@ -49,7 +53,8 @@ fn mk_fold<T:copy>(
|
|||||||
fold_fn: fold_fn,
|
fold_fn: fold_fn,
|
||||||
fold_const: fold_const,
|
fold_const: fold_const,
|
||||||
fold_enum: fold_enum,
|
fold_enum: fold_enum,
|
||||||
fold_res: fold_res
|
fold_res: fold_res,
|
||||||
|
fold_iface: fold_iface
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -61,7 +66,8 @@ fn default_seq_fold<T:copy>(ctxt: T) -> fold<T> {
|
|||||||
{|f, d| default_seq_fold_fn(f, d)},
|
{|f, d| default_seq_fold_fn(f, d)},
|
||||||
{|f, d| default_seq_fold_const(f, d)},
|
{|f, d| default_seq_fold_const(f, d)},
|
||||||
{|f, d| default_seq_fold_enum(f, d)},
|
{|f, d| default_seq_fold_enum(f, d)},
|
||||||
{|f, d| default_seq_fold_res(f, d)}
|
{|f, d| default_seq_fold_res(f, d)},
|
||||||
|
{|f, d| default_seq_fold_iface(f, d)}
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -96,6 +102,9 @@ fn default_seq_fold_mod<T>(
|
|||||||
doc::restag(resdoc) {
|
doc::restag(resdoc) {
|
||||||
doc::restag(fold.fold_res(fold, resdoc))
|
doc::restag(fold.fold_res(fold, resdoc))
|
||||||
}
|
}
|
||||||
|
doc::ifacetag(ifacedoc) {
|
||||||
|
doc::ifacetag(fold.fold_iface(fold, ifacedoc))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
with doc
|
with doc
|
||||||
@@ -130,6 +139,13 @@ fn default_seq_fold_res<T>(
|
|||||||
doc
|
doc
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn default_seq_fold_iface<T>(
|
||||||
|
_fold: fold<T>,
|
||||||
|
doc: doc::ifacedoc
|
||||||
|
) -> doc::ifacedoc {
|
||||||
|
doc
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn default_fold_should_produce_same_doc() {
|
fn default_fold_should_produce_same_doc() {
|
||||||
let source = "mod a { fn b() { } mod c { fn d() { } } }";
|
let source = "mod a { fn b() { } mod c { fn d() { } } }";
|
||||||
|
|||||||
Reference in New Issue
Block a user