inline {@inheritdoc}
Used to directly inherit the long description from the parent class in child classes
Gregory Beaver
Tag Documentation written by {@link mailto:cellog@users.sourceforge.net cellog@users.sourceforge.net}
Copyright 2002, Gregory Beaver
phpDocumentor 1.2+
{@inheritdoc}
Description
The {@inheritdoc} inline tag is used in the DocBlocks of classes, methods and class variables of child classes. phpDocumentor will automatically inherit the {@tutorial tags.author.pkg @author tag}, {@tutorial tags.version.pkg @version tag}, and {@tutorial tags.copyright.pkg @copyright tag} from a parent class. In addition, if there is no documentation comment present, it will inherit the parent's documentation.
Note that if the {@inheritdoc} inline tag is not present, and a child class is undocumented, the child class will still attempt to inherit documentation from the parent class as is. {@inheritdoc} allows flexibility of where to put documentation from the parent class in a child class's documentation.
Example
In some cases, the child class may want to simply augment the parent class's documentation. This is the primary purpose {@inheritdoc} was designed for. For example:
This source code will parse as if it was: