Template:Usage: Difference between revisions

From Spherical
Jump to navigation Jump to search
Doc
Added 'return'
Line 1: Line 1:
<includeonly><div class="sph-usage">{{#if: {{{object}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''(''{{{params|}}}'');</div></includeonly>
<includeonly><div class="sph-usage">{{#ifeq: {{{return|}}} | '''{{{return}}} ''' | }}{{#ifeq: {{{object|}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''(''{{{params|}}}'');</div></includeonly>


<noinclude>Use this template to demonstrate Sphere API. Template parameters include:
<noinclude>Use this template to demonstrate Sphere API. Template parameters include:


* '''return''' ''(optional)'' - The return type of the function
* '''object''' ''(optional)'' - The Sphere object this function is a member of, if any
* '''object''' ''(optional)'' - The Sphere object this function is a member of, if any
* '''func''' - The name of the function
* '''func''' - The name of the function

Revision as of 19:21, 20 May 2013


Use this template to demonstrate Sphere API. Template parameters include:

  • return (optional) - The return type of the function
  • object (optional) - The Sphere object this function is a member of, if any
  • func - The name of the function
  • params (optional) - A comma-separated list of function parameters, if any

For example, {{Usage|object=sound|func=play|params=repeat}} will result in:

play(repeat);