IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added doc_field_types to :class:JSCallable, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields.

Browse Source
This commit is contained in:
Daniel Neuhäuser
2010-03-31 15:15:43 +00:00
parent f03f8356d1
commit ae0d464fb1
3 changed files with 46 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
tests/root/objects.txt
View File

@@ -81,11 +81,15 @@ Javascript items
.. js:data:: bar
.. documenting the method of any object
.. js:function:: bar.baz()
.. js:function:: bar.baz(href, callback[, errback])
: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
==========