Fix constructors' doxygen as they can't `@inheritdoc`

Pronovix / password_enhancements

0 stars 3 forks source link

Fix constructors' doxygen as they can't `@inheritdoc` #22

Closed boobaa closed 4 years ago

boobaa commented 5 years ago

Affected classes:

[ ] \Drupal\password_enhancements\Entity\Storage\PolicyEntityStorage
[ ] \Drupal\password_enhancements\Entity\Storage\ConstraintEntityStorage
[ ] \Drupal\password_enhancements\Entity\Policy
[ ] \Drupal\password_enhancements\Entity\PolicyListBuilder
[ ] \Drupal\password_enhancements\Entity\Constraint
[ ] \Drupal\password_enhancements\Entity\ConstraintListBuilder

mxr576 commented 5 years ago

I started to ignore these because everybody ignored this comment on PR reviews, but we should have a policy that @inheritdic should not be used in constructors. Yes, I know, documenting the same things several times and keeping the docblock up to date is boring, but it worth the effort.

ycecube commented 5 years ago

Is it enough if you just mention the extra parameters? I mean like

{@inherhitdoc} 

@param string param5
@param string param6
...

mxr576 commented 5 years ago

Nope, you should describe all again ;S

ycecube commented 5 years ago

Not all, I meant only the additional parameters.

mxr576 commented 5 years ago

and I have just said you should describe all constructor parameters. Even if those that you inherited from parent.

ycecube commented 5 years ago

Right, okay.

boobaa commented 4 years ago

Closed by #57.