如何使apidoc.json参数成为必需?

时间:2017-11-15 16:48:24

标签: json api-doc

超级简单,但在标记文档以生成api-doc时,我无法找到有关如何将参数标记为必需的文档(使用包@:{{3 }})

// My APIDOC markup in my PHP doc

 * @apiParam {String} [type] comma delimited list of any or all of: contests, deals, coupons

...生成以下html:

http://apidocjs.com

我希望显示的optional成为required。那个标记是什么?

1 个答案:

答案 0 :(得分:1)

找到它。事实证明你只需删除变量

周围的[]括号
 * @apiParam {String} required_variable comma delimited list of any or all of: contests, deals, coupons