Template:PublicMethod: Difference between revisions

Content deleted Content added
imported>AntumDeluge
mNo edit summary
imported>AntumDeluge
use dark green text
 
(4 intermediate revisions by the same user not shown)
Line 1:
<noinclude>Template output:
<blockquote>
</noinclude>; ''<span style="color:greendarkgreen;">{{{1|}}}</span>({{#if: {{{params|}}} | {{{params|}}} }})''
: {{#if: {{{desc|}}} | {{{desc|}}} }} {{#if: {{{paramlist|}}} |
{{{paramlist|}}} }} {{#if: {{{ret|}}} |
: ''returns:'' {{#if: {{{rettype|}}} | (<code>{{{rettype|}}}</code>) }} {{{ret|}}} | {{#if: {{{rettype|}}<noinclude></blockquote>} |
: ''returns:'' (<code>{{{rettype|}}}</code>) }} }}<noinclude></blockquote>
 
== Description ==
 
Template for creating method representations.
 
== Examples ==
Example:
 
{{PublicMethod | helloWorld | desc=A test method. | params=param1, param2|paramlist=
{| class="wikitable"
|-
| Input || <nowiki>{{</nowiki>{{PAGENAME}}<nowiki> | helloWorld | desc=A test method. | params=param1, param2|paramlist=</nowiki><br>
<nowiki>{{MethodParam | param1 | type=int | desc=First parameter}}</nowiki><br>
<nowiki>{{MethodParam | param2 | type=String|desc=Second parameter}} | ret=An integer value. | rettype=int }}</nowiki>
|-
| Output || {{PublicMethod{{PAGENAME}} | helloWorld | desc=A test method. | params=param1, param2|paramlist=
{{MethodParam | param1 | type=int | desc=First parameter}}
{{MethodParam | param2 | type=String|desc=Second parameter}} | ret=An integer value. | rettype=int }}
|}
| ret=An integer value. | rettype=int}}
 
 
[[Category:Documentation]]