Difference between revisions of "Template:Enum"

From Kerbal Space Program Wiki
Jump to: navigation, search
m (-don't include template, because it would add the page to the Stubs; +cats;)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly>== {{{name}}} {{lang|en=Enum}} ==
+
<includeonly>|-
 +
| <tt>{{{name|Enum template: name parameter missing}}}</tt>
 +
| <tt>{{{values|Enum template: values parameter missing}}}</tt></includeonly><noinclude>{{doc start}}
 +
An element to be used in [[Template:Enums]].
  
{{{summary|{{Stub}}
+
Takes parameters:
{{lang
 
|en=No summary has been written for this enum.
 
}}
 
}}}</includeonly><noinclude>
 
{{doc start}}
 
This template is used to document enums in the API namespace.
 
  
==Usage Example==
+
:name - The identifier of this enum.
{{tlx|enum|2=name=ClassName|3=desc=...}}
+
:values - The enumeration elements. Use [[Template:EnumValue]] for each value.
  
[[Category:API Templates]]
 
 
[[Category:Templates]]
 
[[Category:Templates]]
</noinclude>
+
[[Category:API Templates]]</noinclude>

Latest revision as of 23:56, 20 October 2015

Documentation for Enum

An element to be used in Template:Enums.

Takes parameters:

name - The identifier of this enum.
values - The enumeration elements. Use Template:EnumValue for each value.