Template:VideoMethod
From OxeyeWiki
(Difference between revisions)
m (wip) |
m (Made the table blueish) |
||
| (5 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | {| border=" | + | {| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;" |
| - | + | ||
|- | |- | ||
| - | |} | + | |style="background:#c7c7e0; font-size:150%;" colspan="3"|'''{{{1}}}''' |
| - | + | |- | |
| - | <noinclude>{{VideoMethod | video.exampleMethod(x, y) }}</noinclude> | + | |colspan="3"| {{{2}}} |
| + | |- | ||
| + | |style="background:#c7c7e0"| '''Parameter''' | ||
| + | |style="background:#c7c7e0"| '''Expected Type''' | ||
| + | |style="background:#c7c7e0"| '''Description''' | ||
| + | |- | ||
| + | {{{3}}} | ||
| + | |style="background:#c7c7e0" colspan="3"| '''Returns''' | ||
| + | |- | ||
| + | |colspan="3"| {{{4}}} | ||
| + | |} {{Video}} | ||
| + | <noinclude> | ||
| + | {{VideoMethod | | ||
| + | video.exampleMethod(x, y) | ||
| + | | | ||
| + | This is an example usage of the VideoMethod template. Video methods should contain this template, with the | ||
| + | paramters for method name, description, parameter list and return values, and then an example of how the | ||
| + | method is used. | ||
| + | | | ||
| + | {{MethodParam|x|A number|This is a parameter using the MethodParam template.}} | ||
| + | {{MethodParam|y|A number|Here's a second parameter. If a method has 0 parameters, you can use the NoParams template instead.}} | ||
| + | | | ||
| + | The fourth parameter is a description of the method's return value or values, if any.}} | ||
| + | </noinclude> | ||
Latest revision as of 09:05, 6 March 2009
| {{{1}}} | ||
| {{{2}}} | ||
| Parameter | Expected Type | Description |
| Returns | ||
| {{{4}}} | ||
|
video.exampleMethod(x, y) | ||
|
This is an example usage of the VideoMethod template. Video methods should contain this template, with the paramters for method name, description, parameter list and return values, and then an example of how the method is used. | ||
| Parameter | Expected Type | Description |
| x | A number | This is a parameter using the MethodParam template. |
| y | A number | Here's a second parameter. If a method has 0 parameters, you can use the NoParams template instead. |
| Returns | ||
|
The fourth parameter is a description of the method's return value or values, if any. | ||
