search

symfony-cmf / simple-cms-bundle

UNMAINTAINED - A more-than-simple cms based on the cmf components
http://cmf.symfony.com/
49 stars 45 forks source link

PHPDoc inheritance on Page object #139

Closed AndrewCarterUK closed 9 years ago

AndrewCarterUK commented 9 years ago

The getNode() method on the Page object should inherit the method documentation from the NodeInterface.

I haven't changed the annotations - but isn't it also:

/**
 * {@inheritdoc}
 */

Rather than:

/**
 * {@inheritDoc}
 */

The first is the example used on the phpDocumentor website and I'd imagine the change in case might cause some IDE's issues even if it is acceptable.

dbu commented 9 years ago

thanks. according to http://phpdoc.org/docs/latest/guides/inheritance.html it should be with camelCase as you put it

AndrewCarterUK commented 9 years ago

Hello,

I'm just reviewing this again and I'm not actually sure that the getNode() method is defined on any of the parent classes or interfaces? I assumed it was extending the PHPCR\NodeInterface but that's been aliased and it's actually extending the Knp\Menu\NodeInterface which doesn't define a getNode() method.

Is there anything for it to actually inherit the documentation from?

Sorry for the hassle!

dbu commented 9 years ago

ups, i should have checked... reverted in #140 thanks for checking again.