Difference between revisions of "Template:Function wrapped"

From Vendetta Lua
Jump to: navigation, search
Line 54: Line 54:
 
{{{notes|}}}
 
{{{notes|}}}
 
</pre>
 
</pre>
 +
 +
==Example==
 +
{{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>
 
</noinclude>
  
Line 60: Line 80:
 
'''Definition:'''<br />
 
'''Definition:'''<br />
 
{{{name|}}}({{
 
{{{name|}}}({{
−
   #if: {{{arg1_name|}}} | {{{arg1_type|}}} {{{arg1_name|}}} | }} {{
+
   #if: {{{arg1_name|}}} |   {{{arg1_type|}}} ''{{{arg1_name|}}}'' | }} {{
−
   #if: {{{arg2_name|}}} | , {{{arg2_type|}}} {{{arg2_name|}}} | }} {{
+
   #if: {{{arg2_name|}}} | , {{{arg2_type|}}} ''{{{arg2_name|}}}'' | }} {{
−
   #if: {{{arg3_name|}}} | , {{{arg3_type|}}} {{{arg3_name|}}} | }} {{
+
   #if: {{{arg3_name|}}} | , {{{arg3_type|}}} ''{{{arg3_name|}}}'' | }} {{
−
   #if: {{{arg4_name|}}} | , {{{arg4_type|}}} {{{arg4_name|}}} | }} {{
+
   #if: {{{arg4_name|}}} | , {{{arg4_type|}}} ''{{{arg4_name|}}}'' | }} {{
−
   #if: {{{arg5_name|}}} | , {{{arg5_type|}}} {{{arg5_name|}}} | }} {{
+
   #if: {{{arg5_name|}}} | , {{{arg5_type|}}} ''{{{arg5_name|}}}'' | }} {{
−
   #if: {{{arg6_name|}}} | , {{{arg6_type|}}} {{{arg6_name|}}} | }} {{
+
   #if: {{{arg6_name|}}} | , {{{arg6_type|}}} ''{{{arg6_name|}}}'' | }} {{
−
   #if: {{{arg7_name|}}} | , {{{arg7_type|}}} {{{arg7_name|}}} | }} {{
+
   #if: {{{arg7_name|}}} | , {{{arg7_type|}}} ''{{{arg7_name|}}}'' | }} {{
−
   #if: {{{arg8_name|}}} | , {{{arg8_type|}}} {{{arg8_name|}}} | }} {{
+
   #if: {{{arg8_name|}}} | , {{{arg8_type|}}} ''{{{arg8_name|}}}'' | }} {{
−
   #if: {{{arg9_name|}}} | , {{{arg9_type|}}} {{{arg9_name|}}} | }}) -> {{
+
   #if: {{{arg9_name|}}} | , {{{arg9_type|}}} ''{{{arg9_name|}}}'' |  
−
   #if: {{{ret1_name|}}} | {{{ret1_type|}}} {{{ret1_name|}}} | }} {{
+
}}) -> {{
−
   #if: {{{ret2_name|}}} | , {{{ret2_type|}}} {{{ret2_name|}}} | }} {{
+
   #if: {{{ret1_name|}}} |   {{{ret1_type|}}} ''{{{ret1_name|}}}'' | }} {{
−
   #if: {{{ret3_name|}}} | , {{{ret3_type|}}} {{{ret3_name|}}} | }} {{
+
   #if: {{{ret2_name|}}} | , {{{ret2_type|}}} ''{{{ret2_name|}}}'' | }} {{
−
   #if: {{{ret4_name|}}} | , {{{ret4_type|}}} {{{ret4_name|}}} | }} {{
+
   #if: {{{ret3_name|}}} | , {{{ret3_type|}}} ''{{{ret3_name|}}}'' | }} {{
−
   #if: {{{ret5_name|}}} | , {{{ret5_type|}}} {{{ret5_name|}}} | }} {{
+
   #if: {{{ret4_name|}}} | , {{{ret4_type|}}} ''{{{ret4_name|}}}'' | }} {{
−
   #if: {{{ret6_name|}}} | , {{{ret6_type|}}} {{{ret6_name|}}} | }} {{
+
   #if: {{{ret5_name|}}} | , {{{ret5_type|}}} ''{{{ret5_name|}}}'' | }} {{
−
   #if: {{{ret7_name|}}} | , {{{ret7_type|}}} {{{ret7_name|}}} | }} {{
+
   #if: {{{ret6_name|}}} | , {{{ret6_type|}}} ''{{{ret6_name|}}}'' | }} {{
−
   #if: {{{ret8_name|}}} | , {{{ret8_type|}}} {{{ret8_name|}}} | }} {{
+
   #if: {{{ret7_name|}}} | , {{{ret7_type|}}} ''{{{ret7_name|}}}'' | }} {{
−
   #if: {{{ret9_name|}}} | , {{{ret9_type|}}} {{{ret9_name|}}} | }}
+
   #if: {{{ret8_name|}}} | , {{{ret8_type|}}} ''{{{ret8_name|}}}'' | }} {{
−
<br />
+
   #if: {{{ret9_name|}}} | , {{{ret9_type|}}} ''{{{ret9_name|}}}'' |  
−
'''Description:'''<br />
+
}}<br />
−
{{{desc|}}}
+
;Description:
 +
:{{{desc|}}}
 
<br />
 
<br />
−
'''Arguments:'''<br />
+
;Arguments:
−
{{#if: {{{arg1_name|}}} | ''{{{arg1_name|}}}'' -- {{{arg1_desc|}}}<br /> | }}
+
{{#if: {{{arg1_name|}}} | : {{{arg1_type|}}} ''{{{arg1_name|}}}'' -- {{{arg1_desc|}}} | }}
−
{{#if: {{{arg2_name|}}} | ''{{{arg2_name|}}}'' -- {{{arg2_desc|}}}<br /> | }}
+
{{#if: {{{arg2_name|}}} | : {{{arg2_type|}}} ''{{{arg2_name|}}}'' -- {{{arg2_desc|}}} | }}
−
{{#if: {{{arg3_name|}}} | ''{{{arg3_name|}}}'' -- {{{arg3_desc|}}}<br /> | }}
+
{{#if: {{{arg3_name|}}} | : {{{arg3_type|}}} ''{{{arg3_name|}}}'' -- {{{arg3_desc|}}} | }}
−
{{#if: {{{arg4_name|}}} | ''{{{arg4_name|}}}'' -- {{{arg4_desc|}}}<br /> | }}
+
{{#if: {{{arg4_name|}}} | : {{{arg4_type|}}} ''{{{arg4_name|}}}'' -- {{{arg4_desc|}}} | }}
−
{{#if: {{{arg5_name|}}} | ''{{{arg5_name|}}}'' -- {{{arg5_desc|}}}<br /> | }}
+
{{#if: {{{arg5_name|}}} | : {{{arg5_type|}}} ''{{{arg5_name|}}}'' -- {{{arg5_desc|}}} | }}
−
{{#if: {{{arg6_name|}}} | ''{{{arg6_name|}}}'' -- {{{arg6_desc|}}}<br /> | }}
+
{{#if: {{{arg6_name|}}} | : {{{arg6_type|}}} ''{{{arg6_name|}}}'' -- {{{arg6_desc|}}} | }}
−
{{#if: {{{arg7_name|}}} | ''{{{arg7_name|}}}'' -- {{{arg7_desc|}}}<br /> | }}
+
{{#if: {{{arg7_name|}}} | : {{{arg7_type|}}} ''{{{arg7_name|}}}'' -- {{{arg7_desc|}}} | }}
−
{{#if: {{{arg8_name|}}} | ''{{{arg8_name|}}}'' -- {{{arg8_desc|}}}<br /> | }}
+
{{#if: {{{arg8_name|}}} | : {{{arg8_type|}}} ''{{{arg8_name|}}}'' -- {{{arg8_desc|}}} | }}
−
{{#if: {{{arg9_name|}}} | ''{{{arg9_name|}}}'' -- {{{arg9_desc|}}}<br /> | }}
+
{{#if: {{{arg9_name|}}} | : {{{arg9_type|}}} ''{{{arg9_name|}}}'' -- {{{arg9_desc|}}} | }}
 
<br />
 
<br />
−
'''Returns:'''<br />
+
;Returns:
−
{{#if: {{{ret1_name|}}} | ''{{{ret1_name|}}}'' -- {{{ret1_desc|}}}<br /> | }}
+
{{#if: {{{ret1_name|}}} | : {{{ret1_type|}}} ''{{{ret1_name|}}}'' -- {{{ret1_desc|}}} | }}
−
{{#if: {{{ret2_name|}}} | ''{{{ret2_name|}}}'' -- {{{ret2_desc|}}}<br /> | }}
+
{{#if: {{{ret2_name|}}} | : {{{ret2_type|}}} ''{{{ret2_name|}}}'' -- {{{ret2_desc|}}} | }}
−
{{#if: {{{ret3_name|}}} | ''{{{ret3_name|}}}'' -- {{{ret3_desc|}}}<br /> | }}
+
{{#if: {{{ret3_name|}}} | : {{{ret3_type|}}} ''{{{ret3_name|}}}'' -- {{{ret3_desc|}}} | }}
−
{{#if: {{{ret4_name|}}} | ''{{{ret4_name|}}}'' -- {{{ret4_desc|}}}<br /> | }}
+
{{#if: {{{ret4_name|}}} | : {{{ret4_type|}}} ''{{{ret4_name|}}}'' -- {{{ret4_desc|}}} | }}
−
{{#if: {{{ret5_name|}}} | ''{{{ret5_name|}}}'' -- {{{ret5_desc|}}}<br /> | }}
+
{{#if: {{{ret5_name|}}} | : {{{ret5_type|}}} ''{{{ret5_name|}}}'' -- {{{ret5_desc|}}} | }}
−
{{#if: {{{ret6_name|}}} | ''{{{ret6_name|}}}'' -- {{{ret6_desc|}}}<br /> | }}
+
{{#if: {{{ret6_name|}}} | : {{{ret6_type|}}} ''{{{ret6_name|}}}'' -- {{{ret6_desc|}}} | }}
−
{{#if: {{{ret7_name|}}} | ''{{{ret7_name|}}}'' -- {{{ret7_desc|}}}<br /> | }}
+
{{#if: {{{ret7_name|}}} | : {{{ret7_type|}}} ''{{{ret7_name|}}}'' -- {{{ret7_desc|}}} | }}
−
{{#if: {{{ret8_name|}}} | ''{{{ret8_name|}}}'' -- {{{ret8_desc|}}}<br /> | }}
+
{{#if: {{{ret8_name|}}} | : {{{ret8_type|}}} ''{{{ret8_name|}}}'' -- {{{ret8_desc|}}} | }}
−
{{#if: {{{ret9_name|}}} | ''{{{ret9_name|}}}'' -- {{{ret9_desc|}}}<br /> | }}
+
{{#if: {{{ret9_name|}}} | : {{{ret9_type|}}} ''{{{ret9_name|}}}'' -- {{{ret9_desc|}}} | }}
 
<br />
 
<br />
−
'''Notes:'''<br />
+
;Notes:
−
{{{notes|}}}
+
:{{{notes|}}}
 
</includeonly>
 
</includeonly>

Revision as of 01:10, 31 March 2011

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. 

=== {{{name}}} ===
'''Definition:'''<br />
{{{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|}}}|}}
<br />
'''Description:'''<br />
{{{desc}}}
<br />
'''Arguments:'''<br />
{{#if:{{{arg1_name|}}}|''{{{arg1_name|}}}'' -- {{{arg1_desc|}}}<br />|}}
{{#if:{{{arg2_name|}}}|''{{{arg2_name|}}}'' -- {{{arg2_desc|}}}<br />|}}
{{#if:{{{arg3_name|}}}|''{{{arg3_name|}}}'' -- {{{arg3_desc|}}}<br />|}}
{{#if:{{{arg4_name|}}}|''{{{arg4_name|}}}'' -- {{{arg4_desc|}}}<br />|}}
{{#if:{{{arg5_name|}}}|''{{{arg5_name|}}}'' -- {{{arg5_desc|}}}<br />|}}
{{#if:{{{arg6_name|}}}|''{{{arg6_name|}}}'' -- {{{arg6_desc|}}}<br />|}}
{{#if:{{{arg7_name|}}}|''{{{arg7_name|}}}'' -- {{{arg7_desc|}}}<br />|}}
{{#if:{{{arg8_name|}}}|''{{{arg8_name|}}}'' -- {{{arg8_desc|}}}<br />|}}
{{#if:{{{arg9_name|}}}|''{{{arg9_name|}}}'' -- {{{arg9_desc|}}}<br />|}}
<br />
'''Returns:'''<br />
{{#if:{{{ret1_name|}}}|''{{{ret1_name|}}}'' -- {{{ret1_desc|}}}<br />|}}
{{#if:{{{ret2_name|}}}|''{{{ret2_name|}}}'' -- {{{ret2_desc|}}}<br />|}}
{{#if:{{{ret3_name|}}}|''{{{ret3_name|}}}'' -- {{{ret3_desc|}}}<br />|}}
{{#if:{{{ret4_name|}}}|''{{{ret4_name|}}}'' -- {{{ret4_desc|}}}<br />|}}
{{#if:{{{ret5_name|}}}|''{{{ret5_name|}}}'' -- {{{ret5_desc|}}}<br />|}}
{{#if:{{{ret6_name|}}}|''{{{ret6_name|}}}'' -- {{{ret6_desc|}}}<br />|}}
{{#if:{{{ret7_name|}}}|''{{{ret7_name|}}}'' -- {{{ret7_desc|}}}<br />|}}
{{#if:{{{ret8_name|}}}|''{{{ret8_name|}}}'' -- {{{ret8_desc|}}}<br />|}}
{{#if:{{{ret9_name|}}}|''{{{ret9_name|}}}'' -- {{{ret9_desc|}}}<br />|}}
<br />
'''Notes:'''<br />
{{{notes|}}}

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





Retrieved from "https://www.vo-wiki.com/racecar2/index.php?title=Template:Function_wrapped&oldid=1558"