CODEWITHSUNDEEP
phpphpdoc
Pitoziq
Pitoziq

Reputation: 49

Optional argument in phpDoc @method signature

Is there a way to mark argument in @method signature as optional in phpDoc?

Something like this:

/*
* @method bool alloc() alloc(int $filesize [, string &$result]) Allocates space for a file to be uploaded
*/

Upvotes: 4

Views: 1955

Answers (1)

ashnazg
ashnazg

Reputation: 6688

Usually, an optional argument is recognized by phpDocumentor by seeing what the arg's default value is in the method signature. As such, using your example:

@method bool alloc() alloc(int $filesize, string &$result = '') Allocates space for ...

Upvotes: 6

Related Questions