Previous Up Next
@subpackage phpDocumentor tags @tutorial


Document changes that will be made in the future

Gregory Beaver
Tag Documentation written by [email protected]
Copyright 2002, Gregory Beaver
(phpDocumentor 1.0+)
@todo information string [unspecified format]


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.


Here's an example:

  1. /**
  2.  * Page-level DocBlock
  3.  * @package unfinished
  4.  * @todo finish the functions on this page
  5.  */
  6. /**
  7.  * function datafunction
  8.  * @todo make it do something
  9.  */
  10. function datafunction()
  11. {
  12. }

Previous Up Next
@subpackage phpDocumentor tags @tutorial

Documentation generated on Mon, 05 Dec 2011 21:13:05 -0600 by phpDocumentor 1.4.4