The @Deprecated Tag


	Resources

	FAQ Online Help File Examples External Links


	Online Help File

	The Time2HELP help file is available online.


	Order Time2HELP

	Order Time2help and pay by credit card, check or bank transfer.

	Order online from Kagi.


	Download trial version

	Download the 30 day trial version of Time2HELP now.


Painless Documentation for your Source Code



		Home Features Download Support News Order

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;