Template:Smcfunc/doc From Online Manual

< Template:Smcfunc
Revision as of 10:24, 16 April 2011 by Emanuele (talk | contribs) (Created page with "This template should be used for pages describing $smcFunc functions. The parameters are: {{parmdesc |function|d1=the name of the function described |usage|d2=how the functi...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This template should be used for pages describing $smcFunc functions.

The parameters are:

  • function the name of the function described
  • usage how the function is called with all the parameters that can be used
  • description a short description of what the function does
  • parameters a list of all the parameters with a short description, please use the {{parmdesc}} to create the list
  • example an example of how the function must be used, please use the <nowiki> and </nowiki> tag to surround the code block as described in the {{code}} template documentation
  • return short description of what the function returns if anything is returned


Advertisement: