php - phpDocumentor does not override docs of parent class -
so, have following setup:
class { /** * documentation */ public function foo() {} } class b extends { /** * documentation way more specific in class */ public function foo() {} }
when try document phpdocumentor2 displays @ method foo() class b "this documentation", i'd " documentation way more specific in class a". in phpdocumenter 1, looks expected. so, going on here? new default behavior of phpdocumentor2? , if so, there way change it? or bug?
note: while doing research, bumped {@inheritdoc}, i'd have exact opposite behavior.
what expecting see in example should happening -- a::foo() should show "this documentation" while b::foo() should show "this documentation way more specific in class a". if that's not happening, bug. please open issue @ https://github.com/phpdocumentor/phpdocumentor2 on it.
as aside, intent of {@inheritdoc} embed a::foo()'s long description somewhere in middle of b::foo()'s overall doc. having descriptions in b::foo()'s docblock, sort of override proper default behavior of a::foo()'s info being automatically inherited b::foo(). {@inheritdoc} tag created had opportunity write description b::foo() , still able include description a::foo(). placement of {@inheritdoc} in b::foo()'s docblock meant control a:foo()'s description appear in b's overall description.
a vast majority of usage see in wild {@inheritdoc} people think must used inherit descriptions , tags parent. think has been due buggy implementations in phpdoc 1.x natural inheritance did not work correctly, , therefore people thought tag had used, though still did not give them after.
Comments
Post a Comment