diff options
| author | DasIch <dasdasich@googlemail.com> | 2010-03-31 15:15:43 +0000 |
|---|---|---|
| committer | DasIch <dasdasich@googlemail.com> | 2010-03-31 15:15:43 +0000 |
| commit | 3efaca0d0ac9fee32ae3685debfa4c6f61653b5c (patch) | |
| tree | 84e5e890370fdc9d7e1bc634edcb79e6c6bbd1dc /tests | |
| parent | 0394de3a4c27b7d7d0a0434ed5123dc075810b42 (diff) | |
| download | sphinx-3efaca0d0ac9fee32ae3685debfa4c6f61653b5c.tar.gz | |
Added `doc_field_types` to :class:`JSCallable`, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields.
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/root/objects.txt | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/tests/root/objects.txt b/tests/root/objects.txt index 60bb120d..6b392f36 100644 --- a/tests/root/objects.txt +++ b/tests/root/objects.txt @@ -81,10 +81,14 @@ Javascript items .. js:data:: bar .. documenting the method of any object -.. js:function:: bar.baz() +.. js:function:: bar.baz(href, callback[, errback]) -.. js:attribute:: bar.spam + :param string href: The location of the resource. + :param callback: Get's called with the data returned by the resource. + :throws InvalidHref: If the `href` is invalid. + :returns: `undefined` +.. js:attribute:: bar.spam References ========== |