Template:Function wrapped: Difference between revisions

From Vendetta Lua
Jump to navigationJump to search
No edit summary
No edit summary
 
(110 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>
<includeonly><!--
This template is intended to have it's parameters filled by [[Template:Function]].  This template shouldn't be called directly.
-->==={{{name}}}===
There is currently not template code.  the following is only the structure in development.
{{Function_wrapped/sub_start
<pre>
  | Definition
</pre>
  | {{Function/definition | name={{{name}}} | arg_list={{{arg_list}}} | ret_list={{{ret_list}}} }}
}}<!--
-->{{Function_wrapped/sub_start
  | Description
  |{{{desc}}}
}}<!--
-->{{Function_wrapped/sub_start
  | Arguments
  | {{Function_wrapped/cbox
    | {{#explode: {{{arg_list}}} |//| 0}} | {{#explode: {{{arg_list}}} |//| 1}} | {{#explode: {{{arg_list}}} |//| 2}} | {{#explode: {{{arg_list}}} |//| 3}}
    | {{#explode: {{{arg_list}}} |//| 4}} | {{#explode: {{{arg_list}}} |//| 5}} | {{#explode: {{{arg_list}}} |//| 6}} | {{#explode: {{{arg_list}}} |//| 7}}
    | {{#explode: {{{arg_list}}} |//| 8}} | {{#explode: {{{arg_list}}} |//| 9}} | {{#explode: {{{arg_list}}} |//| 10}} | {{#explode: {{{arg_list}}} |//| 11}}
    | {{#explode: {{{arg_list}}} |//| 12}} | {{#explode: {{{arg_list}}} |//| 13}} | {{#explode: {{{arg_list}}} |//| 14}} | {{#explode: {{{arg_list}}} |//| 15}}
    | {{#explode: {{{arg_list}}} |//| 16}} | {{#explode: {{{arg_list}}} |//| 17}} | {{#explode: {{{arg_list}}} |//| 18}} | {{#explode: {{{arg_list}}} |//| 19}}
    | {{#explode: {{{arg_list}}} |//| 20}} | {{#explode: {{{arg_list}}} |//| 21}} | {{#explode: {{{arg_list}}} |//| 22}} | {{#explode: {{{arg_list}}} |//| 23}}
    | {{#explode: {{{arg_list}}} |//| 24}} | {{#explode: {{{arg_list}}} |//| 25}} | {{#explode: {{{arg_list}}} |//| 26}} | {{#explode: {{{arg_list}}} |//| 27}}
    | {{#explode: {{{arg_list}}} |//| 28}} | {{#explode: {{{arg_list}}} |//| 29}} | {{#explode: {{{arg_list}}} |//| 30}} | {{#explode: {{{arg_list}}} |//| 31}}
    | {{#explode: {{{arg_list}}} |//| 32}} | {{#explode: {{{arg_list}}} |//| 33}} | {{#explode: {{{arg_list}}} |//| 34}} | {{#explode: {{{arg_list}}} |//| 35}}
    }}
}}<!--
-->{{Function_wrapped/sub_start
  | Returns
  | {{Function_wrapped/cbox
    | {{#explode: {{{ret_list}}} |//| 0}} | {{#explode: {{{ret_list}}} |//| 1}} | {{#explode: {{{ret_list}}} |//| 2}} |
    | {{#explode: {{{ret_list}}} |//| 4}} | {{#explode: {{{ret_list}}} |//| 5}} | {{#explode: {{{ret_list}}} |//| 6}} |
    | {{#explode: {{{ret_list}}} |//| 8}} | {{#explode: {{{ret_list}}} |//| 9}} | {{#explode: {{{ret_list}}} |//| 10}} |
    | {{#explode: {{{ret_list}}} |//| 12}} | {{#explode: {{{ret_list}}} |//| 13}} | {{#explode: {{{ret_list}}} |//| 14}} |
    | {{#explode: {{{ret_list}}} |//| 16}} | {{#explode: {{{ret_list}}} |//| 17}} | {{#explode: {{{ret_list}}} |//| 18}} |
    | {{#explode: {{{ret_list}}} |//| 20}} | {{#explode: {{{ret_list}}} |//| 21}} | {{#explode: {{{ret_list}}} |//| 22}} |
    | {{#explode: {{{ret_list}}} |//| 24}} | {{#explode: {{{ret_list}}} |//| 25}} | {{#explode: {{{ret_list}}} |//| 26}} |
    | {{#explode: {{{ret_list}}} |//| 28}} | {{#explode: {{{ret_list}}} |//| 29}} | {{#explode: {{{ret_list}}} |//| 30}} |
    | {{#explode: {{{ret_list}}} |//| 32}} | {{#explode: {{{ret_list}}} |//| 33}} | {{#explode: {{{ret_list}}} |//| 34}} |
    }}
}}<!--
-->{{Function_wrapped/sub_start
  | Notes
  | {{{notes}}}
}}


==Example==
{{#if:{{NAMESPACE}}||[[Category:Functions]]}}</includeonly>
{{Function
| name        = FunctionName
| desc        = Function description
| arg1_name    = arg1
| arg1_type    = number
| arg1_desc    = argument (1,2,...,n) description, including examples if so desired
| arg2_name    = arg2
| arg2_type    = string
| arg2_desc    = argument (1,2,...,n) description, including examples if so desired
| ret1_name    = ret1
| ret1_type    = string
| ret1_desc    = return value (1,2,...,n) description, including examples if so desired
| ret2_name    = ret2
| ret2_type    = table
| ret2_desc    = return value (1,2,...,n) description, including examples if so desired
| notes        = notes
}}


<noinclude>
{{Function_wrapped/doc}}
</noinclude>
</noinclude>
<includeonly>
=== {{{name}}} ===
;Definition
:{{{name|}}}({{
  #if: {{{arg1_name|}}} |  {{{arg1_type|}}} ''{{{arg1_name|}}}''|}} {{
  #if: {{{arg2_name|}}} | , {{{arg2_type|}}} ''{{{arg2_name|}}}''|}} {{
  #if: {{{arg3_name|}}} | , {{{arg3_type|}}} ''{{{arg3_name|}}}''|}} {{
  #if: {{{arg4_name|}}} | , {{{arg4_type|}}} ''{{{arg4_name|}}}''|}} {{
  #if: {{{arg5_name|}}} | , {{{arg5_type|}}} ''{{{arg5_name|}}}''|}} {{
  #if: {{{arg6_name|}}} | , {{{arg6_type|}}} ''{{{arg6_name|}}}''|}} {{
  #if: {{{arg7_name|}}} | , {{{arg7_type|}}} ''{{{arg7_name|}}}''|}} {{
  #if: {{{arg8_name|}}} | , {{{arg8_type|}}} ''{{{arg8_name|}}}''|}} {{
  #if: {{{arg9_name|}}} | , {{{arg9_type|}}} ''{{{arg9_name|}}}''|
}}) -> {{
  #if: {{{ret1_name|}}} |  {{{ret1_type|}}} ''{{{ret1_name|}}}''|}} {{
  #if: {{{ret2_name|}}} | , {{{ret2_type|}}} ''{{{ret2_name|}}}''|}} {{
  #if: {{{ret3_name|}}} | , {{{ret3_type|}}} ''{{{ret3_name|}}}''|}} {{
  #if: {{{ret4_name|}}} | , {{{ret4_type|}}} ''{{{ret4_name|}}}''|}} {{
  #if: {{{ret5_name|}}} | , {{{ret5_type|}}} ''{{{ret5_name|}}}''|}} {{
  #if: {{{ret6_name|}}} | , {{{ret6_type|}}} ''{{{ret6_name|}}}''|}} {{
  #if: {{{ret7_name|}}} | , {{{ret7_type|}}} ''{{{ret7_name|}}}''|}} {{
  #if: {{{ret8_name|}}} | , {{{ret8_type|}}} ''{{{ret8_name|}}}''|}} {{
  #if: {{{ret9_name|}}} | , {{{ret9_type|}}} ''{{{ret9_name|}}}''|
}}
;Description
:{{{desc|}}}
;Arguments
{{#if: {{{arg1_name|}}} | : {{{arg1_type|}}} ''{{{arg1_name|}}}'' -- {{{arg1_desc|}}} |}}
{{#if: {{{arg2_name|}}} | : {{{arg2_type|}}} ''{{{arg2_name|}}}'' -- {{{arg2_desc|}}} |}}
{{#if: {{{arg3_name|}}} | : {{{arg3_type|}}} ''{{{arg3_name|}}}'' -- {{{arg3_desc|}}} |}}
{{#if: {{{arg4_name|}}} | : {{{arg4_type|}}} ''{{{arg4_name|}}}'' -- {{{arg4_desc|}}} |}}
{{#if: {{{arg5_name|}}} | : {{{arg5_type|}}} ''{{{arg5_name|}}}'' -- {{{arg5_desc|}}} |}}
{{#if: {{{arg6_name|}}} | : {{{arg6_type|}}} ''{{{arg6_name|}}}'' -- {{{arg6_desc|}}} |}}
{{#if: {{{arg7_name|}}} | : {{{arg7_type|}}} ''{{{arg7_name|}}}'' -- {{{arg7_desc|}}} |}}
{{#if: {{{arg8_name|}}} | : {{{arg8_type|}}} ''{{{arg8_name|}}}'' -- {{{arg8_desc|}}} |}}
{{#if: {{{arg9_name|}}} | : {{{arg9_type|}}} ''{{{arg9_name|}}}'' -- {{{arg9_desc|}}} |}}
;Returns
{{#if: {{{ret1_name|}}} | : {{{ret1_type|}}} ''{{{ret1_name|}}}'' -- {{{ret1_desc|}}} |}}
{{#if: {{{ret2_name|}}} | : {{{ret2_type|}}} ''{{{ret2_name|}}}'' -- {{{ret2_desc|}}} |}}
{{#if: {{{ret3_name|}}} | : {{{ret3_type|}}} ''{{{ret3_name|}}}'' -- {{{ret3_desc|}}} |}}
{{#if: {{{ret4_name|}}} | : {{{ret4_type|}}} ''{{{ret4_name|}}}'' -- {{{ret4_desc|}}} |}}
{{#if: {{{ret5_name|}}} | : {{{ret5_type|}}} ''{{{ret5_name|}}}'' -- {{{ret5_desc|}}} |}}
{{#if: {{{ret6_name|}}} | : {{{ret6_type|}}} ''{{{ret6_name|}}}'' -- {{{ret6_desc|}}} |}}
{{#if: {{{ret7_name|}}} | : {{{ret7_type|}}} ''{{{ret7_name|}}}'' -- {{{ret7_desc|}}} |}}
{{#if: {{{ret8_name|}}} | : {{{ret8_type|}}} ''{{{ret8_name|}}}'' -- {{{ret8_desc|}}} |}}
{{#if: {{{ret9_name|}}} | : {{{ret9_type|}}} ''{{{ret9_name|}}}'' -- {{{ret9_desc|}}} |}}
;Notes
:{{{notes|}}}
</includeonly>

Latest revision as of 06:10, 16 January 2012


This template is intended to have it's parameters filled by Template:Function. This template shouldn't be called directly. There is currently not template code. the following is only the structure in development.


Example

FunctionName

Definition
FunctionName( number  arg1,  string  arg2) ->  string  ret1,  table  ret2
Description
Function description
Arguments
Type Name Description
number arg1 argument (1,2,...,n) description, including examples if so desired
string arg2 argument (1,2,...,n) description, including examples if so desired
Returns
Type Name Description
string ret1 return value (1,2,...,n) description, including examples if so desired
table ret2 return value (1,2,...,n) description, including examples if so desired
Notes
notes