Monday, 15 July 2013

php - PHPDocumentor - what's wrong with my DocBlock? -



php - PHPDocumentor - what's wrong with my DocBlock? -

i'm putting in comments in legacy code, , i've run across little issue phpdocumentor.

here's example:

/** * constructs widget object * * basic constructor widget object. * line of pointless explanation, badly worded. * * @param string $id id of widget * @param int $size size of widget * @return void * @throws invalidargumentexception */ public function __construct($id, $size) { if (!is_string($id) || !is_integer($size)) { throw new invalidargumentexception('$id must string, $size integer'); } $this->id = $id; $this->size = $size; }

i run phpdocumentor command-line, , lovely folder total of documentation.

the documentation looks fine, phpdocumentor compilation errors along lines of:

argument $id missing docblock of __construct

is phpdocumenator whining unnecessarily, or there obvious i'm missing?

i had same issue phpdocumentor version 2.8.1. seems it's bug in version: enter link description here

i used version 2.7.0 , it's fine now.

php phpdoc docblocks

No comments:

Post a Comment