@todo
Document changes that will be made in the future
by Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 1.0+)
@todo
information string [unspecified format]
Description
Use @todo to document planned changes to an element that have not been implemented. phpDocumentor will display the information string unaltered.
The @todo tag may be used to document future changes to almost any element that can be documented (global variable, constant, function, define, class, variable, method, page). Since v1.3.0, @todo can no longer be used on an "include" element.
Example
Here's an example:
/**
* Page-level DocBlock
* @package unfinished
* @todo finish the functions on this page
*/
/**
* function datafunction
* @todo make it do something
*/
function datafunction()
{
}
