[Userdoc] Rewrite tooltips for lots of component properties

# Original commit: 'a563442ce5923c7ba411cd6cecba6f1b10b22295'

Author: jamesduffytokyo

sources/engine/SiliconStudio.Xenko.Assets/Sprite/PackingAttributes.cs

@@ -30,23 +30,23 @@ public PackingAttributes()
         /// <summary>
         /// Gets or sets a value indicating whether to generate texture atlas
         /// </summary>
-        /// <userdoc>If checked, the sprites of the sheet are packed into atlas textures</userdoc>
+        /// <userdoc>Pack the sprites into atlas textures</userdoc>
         [DataMember(0)]
         [DefaultValue(true)]
         public bool Enabled { get; set; }
 
         /// <summary>
         /// Gets or sets MaxRects rectangles placement algorithm
         /// </summary>
-        /// <userdoc>The algorithm used to pack the sprites into atlas.</userdoc>
+        /// <userdoc>The algorithm used to pack the sprites into atlas</userdoc>
         [DataMemberIgnore] // hide this for the moment.
         [DefaultValue(TexturePackingMethod.Best)]
         public TexturePackingMethod PackingAlgorithm { get; set; }
 
         /// <summary>
         /// Gets or sets the use of Multipack atlas mode which allows more than one texture atlas to fit all given textures
         /// </summary>
-        /// <userdoc>Allow the packer to generate several atlas textures if all the sprites cannot fit into one single atlas.</userdoc>
+        /// <userdoc>If the sprites don't fit into a single atlas, generate several atlas textures</userdoc>
         [DataMember(20)]
         [DefaultValue(true)]
         public bool AllowMultipacking { get; set; }

sources/engine/SiliconStudio.Xenko.Assets/Sprite/SpriteInfo.cs

@@ -79,7 +79,7 @@ public class SpriteInfo
         /// Gets or sets the value indicating position provided to <see cref="Center"/> is from the middle of the sprite region or from the left/top corner.
         /// </summary>
         /// <userdoc>
-        /// If checked, the value in 'Center' represents the offset of the sprite center from the middle of the sprite.
+        /// If enabled, the value in Center represents the offset of the sprite center from the middle of the sprite
         /// </userdoc>
         [DataMember(50)]
         [DefaultValue(true)]

sources/engine/SiliconStudio.Xenko.Assets/Sprite/SpriteSheetAsset.cs

@@ -48,7 +48,7 @@ public partial class SpriteSheetAsset : Asset
         /// The type of the sprite sheet.
         /// </userdoc>
         [DataMember(10)]
-        [Display("Sheet Type", category: "Parameters")]
+        [Display("Sheet type", category: "Parameters")]
         public SpriteSheetType Type { get; set; }
 
         /// <summary>
@@ -59,15 +59,15 @@ public partial class SpriteSheetAsset : Asset
         /// The color that should be made transparent in all images of the group.
         /// </userdoc>
         [DataMember(20)]
-        [Display(category: "Parameters")]
+        [Display("Color key color", category: "Parameters")]
         public Color ColorKeyColor { get; set; } = new Color(255, 0, 255);
 
         /// <summary>
         /// Gets or sets a value indicating whether to enable color key. Default is false.
         /// </summary>
         /// <value><c>true</c> to enable color key; otherwise, <c>false</c>.</value>
         /// <userdoc>
-        /// If checked, the color specified by 'ColorKeyColor' is made transparent in all images of the group during the asset build.
+        /// Make the color specified in "Color key color" transparent in all images of the group during the asset build
         /// </userdoc>
         [DataMember(30)]
         [DefaultValue(false)]
@@ -78,11 +78,11 @@ public partial class SpriteSheetAsset : Asset
         /// If Compressed, the final texture will be compressed to an appropriate format based on the target platform. The final texture size must be a multiple of 4.
         /// </summary>
         /// <userdoc>
-        /// If Compressed, the final texture will be compressed to an appropriate format based on the target platform. The final texture size must be a multiple of 4.
+        /// Compress the texture to a format based on the target platform. The final texture size will be a multiple of 4.
         /// </userdoc>
         [DataMember(40)]
         [DefaultValue(true)]
-        [Display("Compressed", "Parameters")]
+        [Display("Compress", "Parameters")]
         public bool IsCompressed { get; set; } = true;
 
         /// <summary>
@@ -115,7 +115,7 @@ public partial class SpriteSheetAsset : Asset
         /// </summary>
         /// <value><c>true</c> if [generate mipmaps]; otherwise, <c>false</c>.</value>
         /// <userdoc>
-        /// If checked, mipmaps are generated for all the images of the group.
+        /// Generate mipmaps for all images in the group
         /// </userdoc>
         [DataMember(60)]
         [DefaultValue(false)]
@@ -139,8 +139,8 @@ public partial class SpriteSheetAsset : Asset
         /// </summary>
         /// <value><c>true</c> to convert the texture in pre-multiply alpha.; otherwise, <c>false</c>.</value>
         /// <userdoc>
-        /// If checked, pre-multiply all color components of the images by their alpha-component.
-        /// Use this when elements are rendered with standard blending (and not transitive blending).
+        /// Pre-multiply all color components of the images by their alpha-component.
+        /// Use this when elements are rendered with standard blending (not transitive blending).
         /// </userdoc>
         [DataMember(70)]
         [DefaultValue(true)]
@@ -151,7 +151,7 @@ public partial class SpriteSheetAsset : Asset
         /// Gets or sets the sprites of the sheet.
         /// </summary>
         /// <userdoc>
-        /// The parameters used to pack the sprites into atlas.
+        /// The parameters used to pack the sprites into atlases
         /// </userdoc>
         [NotNull]
         [DataMember(100)]
@@ -162,7 +162,7 @@ public partial class SpriteSheetAsset : Asset
         /// Gets or sets the sprites of the sheet.
         /// </summary>
         /// <userdoc>
-        /// The list of sprites composing the sheet.
+        /// The list of sprites in the sheet
         /// </userdoc>
         [DataMember(150)]
         [Category]

sources/engine/SiliconStudio.Xenko.Engine/Engine/BackgroundComponent.cs

@@ -51,6 +51,7 @@ public BackgroundComponent()
         /// The render group for this component.
         /// </summary>
         [DataMember(30)]
+        [Display("Render group")]
         [DefaultValue(RenderGroup.Group0)]
         public RenderGroup RenderGroup { get; set; }
     }

sources/engine/SiliconStudio.Xenko.Engine/Engine/CameraComponent.cs

@@ -80,7 +80,7 @@ public CameraComponent(float nearClipPlane, float farClipPlane)
         /// <userdoc>The vertical field of view (in degrees)</userdoc>
         [DataMember(5)]
         [DefaultValue(DefaultVerticalFieldOfView)]
-        [Display("Field Of View")]
+        [Display("Field of view")]
         [DataMemberRange(1.0, 179.0, 1.0, 10.0, 0)]
         public float VerticalFieldOfView { get; set; }
 
@@ -93,7 +93,7 @@ public CameraComponent(float nearClipPlane, float farClipPlane)
         /// <userdoc>The height of the orthographic projection (the orthographic width is automatically calculated based on the target ratio)</userdoc>
         [DataMember(10)]
         [DefaultValue(DefaultOrthographicSize)]
-        [Display("Orthographic Size")]
+        [Display("Orthographic size")]
         public float OrthographicSize { get; set; }
 
         /// <summary>
@@ -122,10 +122,10 @@ public CameraComponent(float nearClipPlane, float farClipPlane)
         /// Gets or sets a value indicating whether to use a custom <see cref="AspectRatio"/>. Default is <c>false</c>, meaning that the aspect ratio is calculated from the ratio of the current viewport when rendering.
         /// </summary>
         /// <value>The use custom aspect ratio.</value>
-        /// <userdoc>If selected, use a custom aspect ratio you specify. Otherwise, automatically adjust the aspect ratio to the render target ratio</userdoc>
+        /// <userdoc>Use a custom aspect ratio you specify. Otherwise, automatically adjust the aspect ratio to the render target ratio.</userdoc>
         [DataMember(35)]
         [DefaultValue(false)]
-        [Display("Custom Aspect Ratio")]
+        [Display("Custom aspect ratio")]
         public bool UseCustomAspectRatio { get; set; }
 
         /// <summary>

sources/engine/SiliconStudio.Xenko.Engine/Engine/ModelComponent.cs

@@ -133,17 +133,18 @@ private void CheckSkeleton()
         /// Gets or sets a boolean indicating if this model component is casting shadows.
         /// </summary>
         /// <value>A boolean indicating if this model component is casting shadows.</value>
-        /// <userdoc>If checked, the model generates a shadow when enabling shadow maps.</userdoc>
+        /// <userdoc>Generate a shadow (when shadow maps are enabled)</userdoc>
         [DataMember(30)]
         [DefaultValue(true)]
-        [Display("Cast Shadows?")]
+        [Display("Cast shadows")]
         public bool IsShadowCaster { get; set; }
 
         /// <summary>
         /// The render group for this component.
         /// </summary>
         [DataMember(20)]
         [DefaultValue(RenderGroup.Group0)]
+        [Display("Render group")]
         public RenderGroup RenderGroup { get; set; }
 
         /// <summary>

sources/engine/SiliconStudio.Xenko.Engine/Engine/SpriteComponent.cs

@@ -142,6 +142,7 @@ public enum SpriteSampler
         /// The render group for this component.
         /// </summary>
         [DataMember(90)]
+        [Display("Render group")]
         [DefaultValue(RenderGroup.Group0)]
         public RenderGroup RenderGroup { get; set; }
 

sources/engine/SiliconStudio.Xenko.Engine/Rendering/Compositing/VRRendererSettings.cs

@@ -31,7 +31,7 @@ public class VRRendererSettings
         /// <summary>
         /// Specifies if VR rendering should be copied to the current render target.
         /// </summary>
-        /// <userdoc>If checked, VR rendering will be copied to the current render target. Can be unchecked to have different rendering on desktop than VR headset.</userdoc>
+        /// <userdoc>Copy VR rendering to the current render target. Leave disabled to have different rendering on desktop than VR headset.</userdoc>
         [DataMember(25)]
         [DefaultValue(true)]
         public bool CopyMirror { get; set; } = true;

sources/engine/SiliconStudio.Xenko.Engine/Rendering/Lights/LightShadowMap.cs

@@ -28,7 +28,7 @@ protected LightShadowMap()
         /// Gets or sets a value indicating whether this <see cref="LightShadowMap"/> is enabled.
         /// </summary>
         /// <value><c>true</c> if enabled; otherwise, <c>false</c>.</value>
-        /// <userdoc>If checked, display the shadow of the engendered by the light.</userdoc>
+        /// <userdoc>Display the shadow of the engendered by the light</userdoc>
         [DataMember(10)]
         [DefaultValue(false)]
         public bool Enabled { get; set; }
@@ -64,7 +64,7 @@ protected LightShadowMap()
         /// Gets or sets a value indicating whether this <see cref="LightShadowMap"/> is debug.
         /// </summary>
         /// <value><c>true</c> if debug; otherwise, <c>false</c>.</value>
-        /// <userdoc>If checked, render the shadow map in debug mode.</userdoc>
+        /// <userdoc>Render the shadow map in debug mode</userdoc>
         [DataMember(200)]
         [DefaultValue(false)]
         public bool Debug { get; set; }

sources/engine/SiliconStudio.Xenko.Engine/Rendering/MaterialAssetKeys.cs

@@ -12,15 +12,15 @@ public sealed class MaterialAssetKeys
         /// parameters of all materials.
         /// </summary>
         /// <userdoc>
-        /// If checked, the material parameters will be used to generate effects.
+        /// Use the material parameters to generate effects
         /// </userdoc>
         public static readonly ValueParameterKey<bool> UseParameters = ParameterKeys.NewValue<bool>();
 
         /// <summary>
         /// Allow material compilation without mesh.
         /// </summary>
         /// <userdoc>
-        /// If checked, the materials will generate a shader even if they are not attached to a mesh.
+        /// Generate a shader even if the materials aren't attached to a mesh
         /// </userdoc>
         public static readonly ValueParameterKey<bool> GenerateShader = ParameterKeys.NewValue<bool>();
     }