Previous Up Next
phpDocumentor tags phpDocumentor tags @access

@abstract

Document an abstract class, class variable or method

Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 1.1+)
@abstract

Description

Use the @abstract tag to declare a method, class variable, or class that must be re-defined in a child class to be valid.

The @abstract tag is only valid in PHP 4, PHP 5 has a keyword abstract.

Example

Here's an example:

  1. /**
  2.  * example of basic @abstract usage in a class
  3.  * Use this if every single element of the class is abstract
  4.  * @abstract
  5.  */
  6. class myabstractclass
  7. {
  8.    function function1($baz)
  9.    {
  10.    ...
  11.    }
  12.    
  13.    function function2()
  14.    {
  15.    ...
  16.    }
  17. }

Previous Up Next
phpDocumentor tags phpDocumentor tags @access

Documentation generated on Sat, 05 Sep 2009 16:14:23 -0500 by phpDocumentor 1.4.3