Project

General

Profile

Bug #17921 » t3_deprecated.txt

Administrator Admin, 2008-01-09 15:19

 
How and When To Deprecate APIs

Here are some general rules on how to remove existing functions or parameter from TYPO3. Generally, functions or parameters are removed two major versions after they are set to be deprecated.


If you want to remove a parameter of a TYPO3 core function, please note it within the JavaDoc param part:

/**
* ...
* @param string DEPRECATED since TYPO3 4.X - is not used anymore because...
* ...
*/

For removing a whole function in one of the TYPO3 core classes, you can use the JavaDoc @deprecated parameter. Use it like this:

/**
* ...
* @return...
* @deprecated since TYPO3 4.X - is not used anymore, use FUNCNAME instead
*/


The Release manager of version TYPO3 4.X+2 will remove deprecated parameters or functions then.
(2-2/3)