如何使用Sphinx记录javascript回调参数?

时间:2017-02-06 22:03:23

标签: javascript python-sphinx

我一直在使用Sphinx文档生成器来记录我的javascript框架,但是我不知道如何记录我的回调函数获取的参数,例如

.. js:function:: execute(event, callback)

  :param object event: The event object 
  :param function callback: the handler 
  :returns: a Promise

在上一个示例中,使用requestreply参数调用回调,但是查看javascript域的sphinx文档并没有指定我应该如何记录这个。

正确的方法是什么?

http://www.sphinx-doc.org/en/stable/domains.html?highlight=js%20domain#the-javascript-domain

0 个答案:

没有答案