Class MyPublicEditorExampleClass
Packages require documentation for ALL public Package APIs.
The summary tags are where you put all basic descriptions. For example, this is where you would normally provide a general description of the class.
Inside these tags, you can use normal markdown, such as bold, italics, and code formatting.
Namespace: Unity.XMLDocExample.UnityEditor.SubGroup.YourPackageName
Syntax
public class MyPublicEditorExampleClassRemarks
For more information on using the XML Documentation comments and the supported tags, see the Microsoft documentation.
Properties
propertyExample
For properties, you can add a description of the property to get/set with the value tag.
Declaration
public MyPublicEditorExampleClass.MyExampleEnum propertyExample { get; }Property Value
| Type | Description |
|---|---|
| MyPublicEditorExampleClass.MyExampleEnum | Description of the property |
Methods
CountThingsAndDoStuff(Int32, Int32, Boolean)
Besides providing a description of what this private method does in the summary tag,
you should also describe each parameter using the param tag and document any return values
with the return tag.
Declaration
public int CountThingsAndDoStuff(int parameter1, int parameter2, bool parameter3)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | parameter1 | Description of parameter 1 |
| Int32 | parameter2 | Description of parameter 2 |
| Boolean | parameter3 | Description of parameter 3 |
Returns
| Type | Description |
|---|---|
| Int32 | Description of what the function returns |