2017-11-15 9 views
0

スーパーシンプルですが、私は私が(@パッケージを使用して:http://apidocjs.com)API-docの生成に私の文書をマークアップするとき必要などのパラメータをマークする方法についてのドキュメントを見つけることができませんapidoc.jsonパラメータを設定するにはどうすればいいですか?

// My APIDOC markup in my PHP doc 

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

を.. 。requiredになることを示すように、私はoptionalをしたい

enter image description here

:次のHTMLを生成します。そのマークアップは何ですか?

答えて

0

見つけました。変数を囲む[]の括弧を削除するだけです。

* @apiParam {String} required_variable comma delimited list of any or all of: contests, deals, coupons 
関連する問題