Previous
|
Up
|
Next
|
inline {@internal}}
|
phpDocumentor Inline tags
|
inline {@link}
|
inline {@inheritdoc}
Used to directly inherit the long description from the parent class in child classes
Gregory Beaver
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)
{@inheritdoc}
Description
The {@inheritdoc} inline tag is used in the class DocBlocks of child classes. phpDocumentor will automatically inherit the @author tag, @version tag, and @copyright tag from a parent class.
{@inheritdoc} allows flexibility of where to put documentation from the parent class in a child class's documentation.
Example
/**
* Makes bars
*
* This class generates bars using the main algorithm.
*/
class bar
{
}
/**
* Makes chocolate bars
*
* There are two aspects to this class.
* {@inheritdoc } In addition, the foo class
* makes the bars chocolate
*/
class foo extends bar
{
}
This source code will parse as if it was:
/**
* Makes bars
*
* Generates bars using the main algorithm.
*/
class bar
{
}
/**
* Makes chocolate bars
*
* There are two aspects to this class.
* This class generates bars using the main algorithm. In addition, the foo class
* makes the bars chocolate
*/
class foo extends bar
{
}
Previous
|
Up
|
Next
|
inline {@internal}}
|
phpDocumentor Inline tags
|
inline {@link}
|
Documentation generated on Mon, 05 Dec 2011 21:13:07 -0600 by phpDocumentor 1.4.4