Comments

metalgearsloth · Aug 19, 2024 · f4badc2 · f4badc2
1 parent bbcc182
commit f4badc2
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/Robust.Shared/Serialization/Manager/Attributes/AlwaysPushInheritanceAttribute.cs b/Robust.Shared/Serialization/Manager/Attributes/AlwaysPushInheritanceAttribute.cs
@@ -3,6 +3,9 @@
 namespace Robust.Shared.Serialization.Manager.Attributes
 {
     // TODO Serialization: find a way to constrain this to DataFields only & make exclusive w/ NeverPush
+    /// <summary>
+    /// Adds the parent DataDefinition field to this field.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
     public sealed class AlwaysPushInheritanceAttribute : Attribute
     {

diff --git a/Robust.Shared/Serialization/Manager/Attributes/IncludeDataFieldAttribute.cs b/Robust.Shared/Serialization/Manager/Attributes/IncludeDataFieldAttribute.cs
@@ -3,6 +3,17 @@
 
 namespace Robust.Shared.Serialization.Manager.Attributes;
 
+/// <summary>
+/// Inlines the datafield instead of putting it into its own node.
+/// </summary>
+/// <remarks>
+/// mapping:
+///   data1: 0
+///   data2: 0
+/// Becomes
+/// data1: 0
+/// data2: 0
+/// </remarks>
 [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
 [MeansImplicitAssignment]
 [MeansImplicitUse(ImplicitUseKindFlags.Assign)]