Template:PublicMethod: Difference between revisions

Jump to navigation Jump to search
Content deleted Content added
imported>AntumDeluge
Allow "rettype" param to be used without "ret"
imported>AntumDeluge
use dark green text
 
Line 1: Line 1:
<noinclude>Template output:
<noinclude>Template output:
<blockquote>
<blockquote>
</noinclude>; ''<span style="color:green;">{{{1|}}}</span>({{#if: {{{params|}}} | {{{params|}}} }})''
</noinclude>; ''<span style="color:darkgreen;">{{{1|}}}</span>({{#if: {{{params|}}} | {{{params|}}} }})''
: {{#if: {{{desc|}}} | {{{desc|}}} }} {{#if: {{{paramlist|}}} |
: {{#if: {{{desc|}}} | {{{desc|}}} }} {{#if: {{{paramlist|}}} |
{{{paramlist|}}} }} {{#if: {{{ret|}}} |
{{{paramlist|}}} }} {{#if: {{{ret|}}} |
: ''returns:'' {{#if: {{{rettype|}}} | (<code>{{{rettype|}}}</code>) }} {{{ret|}}} | {{#if: {{{rettype|}}} |
: ''returns:'' {{#if: {{{rettype|}}} | (<code>{{{rettype|}}}</code>) }} {{{ret|}}} | {{#if: {{{rettype|}}} |
: ''returns:'' (<code>{{{rettype|}}}</code>) }} }}<noinclude></blockquote>
: ''returns:'' (<code>{{{rettype|}}}</code>) }} }}<noinclude></blockquote>

== Description ==


Template for creating method representations.
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 || {{{{PAGENAME}} | helloWorld | desc=A test method. | params=param1, param2|paramlist=
{{MethodParam | param1 | type=int | desc=First parameter}}
{{MethodParam | param1 | type=int | desc=First parameter}}
{{MethodParam | param2 | type=String|desc=Second parameter}} | ret=An integer value. | rettype=int }}
{{MethodParam | param2 | type=String|desc=Second parameter}} | ret=An integer value. | rettype=int }}
|}


[[Category:Documentation]]