Improve {@inheritdoc} behavior #4686

[junichi11]

#4686

• Support {@inheritdoc} for fields and constants
• Replace {@inheritdoc} with whole parent sentences

Example

<?php

/**
 * Parent class.
 * 
 */
class ParentClass
{
	/**
	 * Parernt field.
	 */
	public $field;

        /**
         * Parent const.
         */
        public const CONSTANT = "CONSTANT";

	/**
	 * Parent method.
	 */
	public function method() {}
}

class Child extends ParentClass
{
	public $field = 'field';

        public const CONSTANT = "CONSTANT";

        public function method() {}
}

/**
 * {@inheritDoc}
 */
class ChildWithTag extends ParentClass
{
	/**
	 * {@inheritDoc}
	 */
	public $field = 'field';

        /**
         * {@inheritDoc}
         */
        public const CONSTANT = "CONSTANT";

	/**
	 * {@inheritDoc}
	 */
	public function method() {}
}

/**
 * Header.
 * {@inheritDoc} Child class.
 * 
 */
class ChildWithTagAndAdditionalComment extends ParentClass
{
	/**
	 * {@inheritDoc} child field.
	 */
	public $field = 'field';

        /**
         * {@inheritDoc} child const.
         */
        public const CONSTANT = "CONSTANT";

	/**
	 * Header.
         * {@inheritDoc} child method.
         * test.
	 */
	public function method() {}
}

$parent = new ParentClass();
$parent->field;
$parent::CONSTANT;
$parent->method();

$child = new Child();
$child->field;
$child::CONSTANT;
$child->method();

$childWithTag = new ChildWithTag();
$childWithTag->field;
$childWithTag::CONSTANT;
$childWithTag->method();

$childWithTag2 = new ChildWithTagAndAdditionalComment();
$childWithTag2->field;
$childWithTag2::CONSTANT;
$childWithTag2->method();

[junichi11]

@tmysik Could you please have a look at this when you have time? If there is no problem, let's merge it. Thanks.

I've implemented this based on PhpDocumentor in the past. If there is exact documentation for {@inheritdoc}, we should follow it. However, I can't find the exact specification about {@inheritDoc} now...
Currently, when PHPDoc has only a single sentence(e.g. Get something.), inline {@inheritdoc} is not replaced by anything (e.g. /** {@inheritdoc} something...*/). If only {@inheritdoc} is written, {@inheritdoc} is replaced with it(Get something). So, I've changed it to the same behavior.

[tmysik]

Looks good to me. Thanks for all the tests.

[junichi11]

@tmysik Thank you for your review!

[tmysik]

@junichi11 Nothing to thank for, really. You did the job, as always.