@abstract
Document an abstract class or method
Gregory Beaver
Chuck Burgess
Copyright 2002, Gregory Beaver
(phpDocumentor 1.1+)
@abstract
Description
Use the @abstract tag to declare a class as abstract, as well as for declaring what methods must be redefined in a child class.
The @abstract tag is only valid in PHP 4, PHP 5 has a keyword abstract.
Example
Here's an example:
/**
* example of @abstract usage in a class
*
* if even one method is declared abstract,
* then the class itself should be also
* @abstract
*/
class myAbstractClass
{
/**
* this method is abstract...
* it has no body...
* @abstract
*/
function function1($baz)
{
// no body
}
/**
* this method is not abstract
*/
function function2()
{
// does something
...
}
}