Template:Method/doc

This template is used to describe a method. It will generally be used on the page of the class that it belongs to.

Technical details
In essence, this template does nothing other than just passing all the arguments it receive to the member template, together with an additional type argument, which will always be "method".

Parameters
'''It is important to fill all the parameters that apply. Leaving out parameters may cause problems and makes the page look unprofessional. If you don't know what to put in a field, ask for help on the talk page.'''


 * name
 * The name of the member. Would be "FindFirstChild", in the case of the  method.


 * level
 * The level of the member's section header. The default value for this parameter is 2.


 * pt1 - pt9
 * The type of the parameters. In the case of the  method, pt1 would be "Tuple".


 * pn1 - pn9
 * The name of the parameters. In the case of the  method, pn1 would be "arguments". These names should not be invented, they should be the names that appear in the API dump and in the object browser.


 * pd1 - pd9
 * The description of the parameters (usually a short sentence that describes the parameter).


 * pdv1 - pdv9
 * The default value of the parameters. If there is one, it can be found in the object browser or in the API dump.


 * rt1 - rt9
 * The type of the returned values.


 * rd1 - rd9
 * The description of the returned values (a short sentence that describes what is returned).


 * description
 * The description of the method.


 * status
 * The status of the method. Must be 'deprecated', 'readonly', 'preliminary' or 'hidden'. The status of a method can be found in the API dump or in the object browser.


 * status2
 * The second status of the method, for methods that have more than one status. Must conform to the same rules as the status parameter.


 * security
 * The security identifier of the method, for methods that cannot be used by all threads. This information can only be found in the API dump and must be 'RobloxPlaceSecurity', 'RobloxScriptSecurity', 'LocalUserSecurity' or 'RobloxSecurity'.