Domain(env) |
A Domain is meant to be a group of “object” description directives for objects of a similar nature, and corresponding roles to create references to them. |
Field(name[, names, label, has_arg, ...]) |
A doc field that is never grouped. |
GroupedField(name[, names, label, rolename, ...]) |
A doc field that is grouped; i.e., all fields of that type will be transformed into one field with its body being a bulleted list. |
JSCallable(name, arguments, options, ...) |
Description of a JavaScript function, method or constructor. |
JSConstructor(name, arguments, options, ...) |
Like a callable but with a different prefix. |
JSObject(name, arguments, options, content, ...) |
Description of a JavaScript object. |
JSXRefRole([fix_parens, lowercase, ...]) |
|
JavaScriptDomain(env) |
JavaScript language domain. |
ObjType(lname, *roles, **attrs) |
An ObjType is the description for a type of object that a domain can document. |
ObjectDescription(name, arguments, options, ...) |
Directive to describe a class, function or similar object. |
TypedField(name[, names, typenames, label, ...]) |
A doc field that is grouped and has type information for the arguments. |
XRefRole([fix_parens, lowercase, nodeclass, ...]) |
A generic cross-referencing role. |