ParamReturnsRaisesTag

PasDoc supports three tags for describing functions: @param, @returns and @raises.

@param marks the description of a function's parameter
@returns marks the description of a function's result value
@raises marks the description of an exception raised inside a function

Examples:

   1 { This does something with name and value.
   2   @param(Name is a string with the item's name)
   3   @param(Value is a string with the item's value)
   4   @returns(@true on success, @false otherwise)
   5   @raises(EUnknownItem if the name can not be found) }
   6 function DoSomething(const Name: string; 
   7   const Value: string): boolean;

PasDoc does not check whether the parameter names in the description match those of the function. This can be a feature if your coding guidelines require some special syntax for parameters like this

   1 function DoSomething(const _Name: string; 
   2   const _Value: string): boolean;

But you don't want to see those underscores in the description.