The @Deprecated Tag

Syntax

@deprecated explanation

Synonyms

None.

Description

Specifies that the following item is deprecated (should not be used for new development, but currently supported for backwards compatibility). In the explanation section, you should direct the reader to the method/class etc which now contains this functionality, and you may include the motivation for why the item has been deprecated. Applicable to all items.

Example

{:This is a nice routine.
@deprecated Please use AnotherMethod instead}
Function CalculateDay(const i_name: String; const i_date: TDateTime): TDateTime;
Begin
...
End;


HTML generated by Time2HELP
http://www.time2help.com