@final
Document a class method that should never be overridden in a child class
Gregory Beaver
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)
@final
Description
Use the @final tag to declare a method that cannot be overridden in a child class.
The @final tag is only valid in PHP 4, PHP 5 has a keyword final.
Example
Here's an example:
- /**
- * example of basic @final usage in a class
- */
- class myclass
- {
- /**
- * function1 should never be overridden
- * @final
- */
- function function1($baz)
- {
- ...
- }
-
- function function2()
- {
- ...
- }
- }