The K Desktop Environment

A.5. Tags for Functions

@param <paramname> <text>

Documentation for a parameter. No check is done whether the parameter name specified is actually a parameter of the function.

@return <text>

Documentation for the value returned by the function.

@throws <ref>,...

Define the exceptions that may be thrown from this function. Synonyms are: @exception and @raises.

@param <paramname> <text>

Documentation for a parameter. No check is done whether the parameter name specified is actually a parameter of the function.