Template:Method

From Sunhill Framework Documentation

This template creates the description of a class method

Example:

{{Method
 |Name=TestMethod
 |Description=This method does something wonderful
 |Returntype=Integer
 |Parameters=
 {{Parameter
  |Name=ParameterA
  |Type=String
  |Description=An string parameter}} 
 {{Parameter
  |Name=ParameterB
  |Type=Integer
  |Default=10
  |Description=An integer parameter with default of 10}}
 |Test=/tests/Unit/Some/TestTest.php 

creates

TestMethod

Description

This method does something wonderful

Parameters

Name Type Default Description
ParameterA String An string parameter
ParameterB Integer 10 An integer parameter with default of 10

Return type

Integer