Wie werden apidoc.json Parameter benötigt?

Question

Super einfach, aber ich kann nicht die Dokumentationen finden, wie man einen Parameter markieren als erforderlich ist, wenn ich mein Dokument Markup eine api-doc (mit dem Paket @: http://apidocjs.com) zu erzeugen

// My APIDOC markup in my PHP doc 

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

.. ., die generiert die folgende html:

ich möchte die optional wie werden required gezeigt. Was ist das Markup dafür?

Answer 1

Es gefunden. Stellt sich heraus, dass Sie nur die [] Klammern um die Variable

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

entfernen