Difference between revisions of "Template:Class"
From Kerbal Space Program Wiki
(+inherits support;) |
|||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == {{{name}}} {{lang|en=Class}} == | + | <includeonly>== {{{name}}} {{lang|en=Class}} == |
| − | {{#if: {{{inherits|}}}|{{(!}} class="wikitable" style="float:right;" | + | {{#if: {{{inherits|}}}{{{implements|}}}|{{(!}} class="wikitable" style="float:right;" |
! Inherits | ! Inherits | ||
| + | ! Implements | ||
{{!}}- | {{!}}- | ||
| − | {{!}} {{{inherits}}} | + | {{!}} {{{inherits|}}} |
| + | {{!}} {{{implements|}}} | ||
{{!)}}}} | {{!)}}}} | ||
{{{summary|{{Stub}} | {{{summary|{{Stub}} | ||
| Line 9: | Line 11: | ||
|en=No summary has been written for this class. | |en=No summary has been written for this class. | ||
}} | }} | ||
| − | }}}<noinclude> | + | }}} |
| + | {{clear}}</includeonly><noinclude> | ||
{{doc start}} | {{doc start}} | ||
This template is used to document classes in the API namespace. | This template is used to document classes in the API namespace. | ||
| − | ==Usage | + | == Parameters == |
| + | {{Parameter table|name=text|parameters= | ||
| + | {{Parameter row|name|Name of class}} | ||
| + | {{Parameter row|inherits|Inheritance values. Already in a table if set.|Not set}} | ||
| + | {{Parameter row|implements|Interface implementation. Already in a table if set.|Not set}} | ||
| + | {{Parameter row|summary|Summary text.|{{Tl|Stub}} and “No summary has been written for this class.”}} | ||
| + | }} | ||
| + | |||
| + | ==Usage Examples== | ||
| + | {{tlx|class|2=name=ClassName}} | ||
| + | |||
{{tlx|class|2=name=ClassName{{!}}inherits=Inheritance}} | {{tlx|class|2=name=ClassName{{!}}inherits=Inheritance}} | ||
| + | |||
| + | {{tlx|class|2=name=ClassName{{!}}inherits=Inheritance{{!}}implements=IOne, ITwo}} | ||
| + | |||
| + | {{class|name=ClassName}} | ||
| + | |||
| + | {{class|name=ClassName|inherits=Inheritance}} | ||
| + | |||
| + | {{class|name=ClassName|inherits=Inheritance|implements=IOne, ITwo}} | ||
| + | |||
| + | [[Category:Templates]] | ||
| + | [[Category:API Templates]] | ||
</noinclude> | </noinclude> | ||
Latest revision as of 21:48, 16 October 2015
Contents
Documentation for Class
This template is used to document classes in the API namespace.
Parameters
| Name | Optional | Description | Default |
|---|---|---|---|
| name | No | Name of class | |
| inherits | Yes | Inheritance values. Already in a table if set. | Not set |
| implements | Yes | Interface implementation. Already in a table if set. | Not set |
| summary | Yes | Summary text. | {{Stub}} and “No summary has been written for this class.” |
Usage Examples
{{class|name=ClassName}}
{{class|name=ClassName|inherits=Inheritance}}
{{class|name=ClassName|inherits=Inheritance|implements=IOne, ITwo}}
ClassName Class
No summary has been written for this class.
ClassName Class
| Inherits | Implements |
|---|---|
| Inheritance |
No summary has been written for this class.
ClassName Class
| Inherits | Implements |
|---|---|
| Inheritance | IOne, ITwo |
No summary has been written for this class.
