phpDocumentor phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Prev Next
@todo

@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

The @todo tag may be used to document future changes to any element that can be documented (global variable, include, constant, function, define, class, variable, method, page). phpDocumentor will display the information string unaltered.

Use @todo to document planned changes to an element that have not been implemented

Example

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. }

Prev Up Next
@subpackage phpDocumentor tags @tutorial

Documentation generated on Tue, 24 Oct 2006 09:20:13 -0500 by phpDocumentor 1.3.1