Difference between revisions of "Template:Method"

From Kerbal Space Program Wiki
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
For this Wiki site:
 
 
{| class="wikitable"
 
 
|-
 
|-
! {{lang|en=Signature}} !! {{lang|en=Description}}
+
| <tt>{{descr-wrap|towrap={{type|{{{returntype}}}}}{{{array|}}}|desc={{{returndesc|}}}}} {{{name}}}({{{args|}}})</tt>
|-
+
| {{{desc|<small>?</small>}}}<noinclude>
|MethodsStart||Starts a HTML table-like formatted block to explain Methods, their parameters and return values.
+
[[Category:Templates]]
|-
+
[[Category:API Templates]]
|MethodsEnd||Ends a HTML table-like formatted block to explain Methods, their parameters and return values.
+
</noinclude>
|}
 
 
 
For Kerbal Space Program:
 
 
 
 
 
{| class="wikitable"
 
|-
 
! {{lang|en=Signature}} !! {{lang|en=Description}}
 
|-
 
|returntype=[datatype]||Indicates the datatype of the returnvalue, if any. It is good policy to always give a datatype, even if it's 'returntype=void'.
 
|-
 
|returndesc=[description]||Explain what it is that is returned. If it is an object for instance, what object is it? What is it meant for?
 
|-
 
|name=[name]||The name of this method. This is probably the most important bit of information, if you want people to be able to access this method...
 
|-
 
|args=[arguments]||All the arguments that this method requires to function. You can put a whole line of comma seperated stuff in here.
 
|-
 
|desc=[description]||The description for the method itself (the former was for the return value). What does it do? When should it be called? Anything that we need to know when using it?
 
 
 
|}
 

Latest revision as of 16:18, 13 October 2015

|- | {{{returntype}}} {{{name}}}() | ?