Tags

Reference manual for all tags of the documentation generator. Tags begin with the @ (at) symbol and are used to describe an individual component of the documentation page.

@deprecated
Marks an item as being deprecated.
@example
Provides example usage for the item being documented.
@overload
Documents an overloaded function or method. Tags defined for the overload will be re-used by each overload, reducing redundancy.
@param
Documents a function or method parameter.
@return
Documents the return value of a function or method.
@see
Refers to other documentation pages of interest.
@summary
Provides a summary for the documentation page.

HTML | BBCode | Direct Link

Tags

@deprecated

@example

@overload

@param

@return

@see

@summary

Share