Skip to content

Commit 60a6eee

Browse files
committed
add docs
1 parent 32de1c7 commit 60a6eee

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

src/ECS/Base/Attributes.cs

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,34 +74,49 @@ public GenericInstanceTypeAttribute (string componentKey, Type type1, Type type2
7474

7575

7676
#region Friflo ImGui attributes
77+
7778
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
7879
public class UiTypeDomainAttribute : Attribute
7980
{
8081
// ReSharper disable once UnusedParameter.Local
8182
public UiTypeDomainAttribute(string style) { }
8283
}
8384

85+
/// <summary>
86+
/// Enables changing a number field or property with mouse dragging in EcGui.
87+
/// </summary>
8488
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
8589
public class UiDragAttribute : Attribute
8690
{
8791
// ReSharper disable once UnusedParameter.Local
8892
public UiDragAttribute(float speed = 1, float min = 0, float max= 0, string format = null) { }
8993
}
9094

95+
/// <summary>
96+
/// Hides the annotated field or property in EcGui.
97+
/// </summary>
9198
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
9299
public class UiHideAttribute : Attribute
93100
{ }
94101

95-
[AttributeUsage(AttributeTargets.Field)]
96-
public class UiFlagAttribute : Attribute
97-
{
98-
public UiFlagAttribute(string name) { }
99-
}
100102

103+
/// <summary>
104+
/// Defines the layout of a <c>[Flags] enum</c> type in EcGui.<br/>
105+
/// The size of a group, their spacing and the sort order of flags.
106+
/// </summary>
101107
[AttributeUsage(AttributeTargets.Enum)]
102108
public class UiFlagsAttribute : Attribute
103109
{
104110
public UiFlagsAttribute(int groupSize, bool ascending, int groupSpacing) { }
105111
}
106112

113+
/// <summary>
114+
/// Display short name for a <c>[Flags] enum</c> field in EcGui instead its bit index.<br/>
115+
/// </summary>
116+
[AttributeUsage(AttributeTargets.Field)]
117+
public class UiFlagAttribute : Attribute
118+
{
119+
public UiFlagAttribute(string name) { }
120+
}
121+
107122
#endregion

0 commit comments

Comments
 (0)