diff --git a/sources/assets/Stride.Core.Assets/Analysis/AssetBaseAnalysis.cs b/sources/assets/Stride.Core.Assets/Analysis/AssetBaseAnalysis.cs index 48afe849c..2cc607e0d 100644 --- a/sources/assets/Stride.Core.Assets/Analysis/AssetBaseAnalysis.cs +++ b/sources/assets/Stride.Core.Assets/Analysis/AssetBaseAnalysis.cs @@ -12,7 +12,7 @@ using Stride.Core.Reflection; namespace Stride.Core.Assets.Analysis { /// - /// An analysis to validate that all assets in a package have a valid . + /// An analysis to validate that all assets in a package have a valid base. /// In order to be valid, this analysis must be run after a /// public sealed class AssetBaseAnalysis : PackageSessionAnalysisBase diff --git a/sources/assets/Stride.Core.Assets/Compiler/AssetCompilerResult.cs b/sources/assets/Stride.Core.Assets/Compiler/AssetCompilerResult.cs index 1ebc54881..c0f588095 100644 --- a/sources/assets/Stride.Core.Assets/Compiler/AssetCompilerResult.cs +++ b/sources/assets/Stride.Core.Assets/Compiler/AssetCompilerResult.cs @@ -25,7 +25,7 @@ namespace Stride.Core.Assets.Compiler } /// - /// Gets or sets the build steps generated for the build engine. This can be null if is true. + /// Gets or sets the build steps generated for the build engine. This can be null if is true. /// /// The build step. public ListBuildStep BuildSteps { get { return buildSteps; } set { if (value == null) throw new ArgumentNullException("value", @"The BuildSteps property cannot be set to null"); buildSteps = value; } } diff --git a/sources/assets/Stride.Core.Assets/PackageSessionResult.cs b/sources/assets/Stride.Core.Assets/PackageSessionResult.cs index 61f04417b..9033733b8 100644 --- a/sources/assets/Stride.Core.Assets/PackageSessionResult.cs +++ b/sources/assets/Stride.Core.Assets/PackageSessionResult.cs @@ -5,7 +5,7 @@ using Stride.Core.Diagnostics; namespace Stride.Core.Assets { /// - /// Result returned when loading a session using + /// Result returned when loading a session using /// public sealed class PackageSessionResult : LoggerResult { diff --git a/sources/assets/Stride.Core.Assets/Serializers/IdentifiableAssetPartReference.cs b/sources/assets/Stride.Core.Assets/Serializers/IdentifiableAssetPartReference.cs index c80b1c1ff..f646a327a 100644 --- a/sources/assets/Stride.Core.Assets/Serializers/IdentifiableAssetPartReference.cs +++ b/sources/assets/Stride.Core.Assets/Serializers/IdentifiableAssetPartReference.cs @@ -9,7 +9,7 @@ namespace Stride.Core.Assets.Serializers /// An implementation of that represents an asset part implementing . /// /// - /// This type is the default type used when is undefined. + /// This type is the default type used when `AssetPartReferenceAttribute.ReferenceType` is undefined. /// [DataContract] [DataStyle(DataStyle.Compact)] diff --git a/sources/assets/Stride.Core.Assets/UnloadableObjectRemover.cs b/sources/assets/Stride.Core.Assets/UnloadableObjectRemover.cs index 033ba6ef9..823d429d8 100644 --- a/sources/assets/Stride.Core.Assets/UnloadableObjectRemover.cs +++ b/sources/assets/Stride.Core.Assets/UnloadableObjectRemover.cs @@ -11,7 +11,7 @@ using Stride.Core.Yaml; namespace Stride.Core.Assets { /// - /// Removes objects implementing from the object. + /// Removes objects implementing 'IYamlProxy' from the object. /// public class UnloadableObjectRemover : AssetVisitorBase { diff --git a/sources/core/Stride.Core.MicroThreading/Channel.cs b/sources/core/Stride.Core.MicroThreading/Channel.cs index 781f5c2d3..a231665d8 100644 --- a/sources/core/Stride.Core.MicroThreading/Channel.cs +++ b/sources/core/Stride.Core.MicroThreading/Channel.cs @@ -10,7 +10,7 @@ namespace Stride.Core.MicroThreading /// Provides a communication mechanism between . /// /// - /// can send and receive to a . Depending on the , + /// can send and receive to a . Depending on the , /// sending or receiving might be suspended and yield execution to another . /// /// The type of element handled by this channel. diff --git a/sources/core/Stride.Core.Serialization/Storage/IOdbBackend.cs b/sources/core/Stride.Core.Serialization/Storage/IOdbBackend.cs index 41292bdb9..d29fe1b45 100644 --- a/sources/core/Stride.Core.Serialization/Storage/IOdbBackend.cs +++ b/sources/core/Stride.Core.Serialization/Storage/IOdbBackend.cs @@ -55,7 +55,7 @@ namespace Stride.Core.Storage /// /// Creates a stream that will be saved to database when closed and/or disposed. /// - /// a stream writer that should be passed to in order to be stored in the database + /// a stream writer that should be passed to in order to be stored in the database OdbStreamWriter CreateStream(); /// diff --git a/sources/core/Stride.Core.Serialization/Storage/ObjectDatabase.cs b/sources/core/Stride.Core.Serialization/Storage/ObjectDatabase.cs index fe50f124a..1d36c6bc1 100644 --- a/sources/core/Stride.Core.Serialization/Storage/ObjectDatabase.cs +++ b/sources/core/Stride.Core.Serialization/Storage/ObjectDatabase.cs @@ -318,9 +318,9 @@ namespace Stride.Core.Storage } /// - /// Creates a stream that can then be saved directly in the database using . + /// Creates a stream that can then be saved directly in the database using . /// - /// a stream writer that should be passed to in order to be stored in the database + /// a stream writer that should be passed to in order to be stored in the database public OdbStreamWriter CreateStream() { return backendWrite.CreateStream(); diff --git a/sources/core/Stride.Core/Collections/FastTrackingCollectionChangedEventArgs.cs b/sources/core/Stride.Core/Collections/FastTrackingCollectionChangedEventArgs.cs index 66f054e82..84983a37e 100644 --- a/sources/core/Stride.Core/Collections/FastTrackingCollectionChangedEventArgs.cs +++ b/sources/core/Stride.Core/Collections/FastTrackingCollectionChangedEventArgs.cs @@ -38,7 +38,7 @@ namespace Stride.Core.Collections public object Item { get; private set; } /// - /// Gets the previous value. Only valid if is and + /// Gets the previous value. Only valid if is and /// public object OldItem { get; private set; } diff --git a/sources/core/Stride.Core/Collections/TrackingCollectionChangedEventArgs.cs b/sources/core/Stride.Core/Collections/TrackingCollectionChangedEventArgs.cs index 225a49afe..1aaa55b01 100644 --- a/sources/core/Stride.Core/Collections/TrackingCollectionChangedEventArgs.cs +++ b/sources/core/Stride.Core/Collections/TrackingCollectionChangedEventArgs.cs @@ -38,7 +38,7 @@ namespace Stride.Core.Collections public object Item { get; private set; } /// - /// Gets the previous value. Only valid if is and + /// Gets the previous value. Only valid if is and /// public object OldItem { get; private set; } diff --git a/sources/core/Stride.Core/Diagnostics/ExceptionInfo.cs b/sources/core/Stride.Core/Diagnostics/ExceptionInfo.cs index 10e1fb74b..3bd1d20c9 100644 --- a/sources/core/Stride.Core/Diagnostics/ExceptionInfo.cs +++ b/sources/core/Stride.Core/Diagnostics/ExceptionInfo.cs @@ -61,7 +61,7 @@ namespace Stride.Core.Diagnostics public string TypeFullName { get; set; } /// - /// Gets or sets the name of the exception type. Should correspond to the property of the exception type. + /// Gets or sets the name of the exception type. Should correspond to the property of the exception type. /// public string TypeName { get; set; } diff --git a/sources/core/Stride.Core/Diagnostics/ProfilingState.cs b/sources/core/Stride.Core/Diagnostics/ProfilingState.cs index a5417ed75..6cc82f061 100644 --- a/sources/core/Stride.Core/Diagnostics/ProfilingState.cs +++ b/sources/core/Stride.Core/Diagnostics/ProfilingState.cs @@ -12,7 +12,7 @@ namespace Stride.Core.Diagnostics /// A profiler state contains information of a portion of code being profiled. See remarks. /// /// - /// This struct is not intended to be used directly but only through . + /// This struct is not intended to be used directly but only through . /// You can still attach some attributes to it while profiling a portion of code. /// public struct ProfilingState : IDisposable diff --git a/sources/core/Stride.Core/Native/NativeLibraryHelper.cs b/sources/core/Stride.Core/Native/NativeLibraryHelper.cs index d387130e3..1be365559 100644 --- a/sources/core/Stride.Core/Native/NativeLibraryHelper.cs +++ b/sources/core/Stride.Core/Native/NativeLibraryHelper.cs @@ -159,7 +159,7 @@ namespace Stride.Core } /// - /// UnLoad a specific native dynamic library loaded previously by . + /// UnLoad a specific native dynamic library loaded previously by . /// /// Name of the library to unload. public static void UnLoad(string libraryName) @@ -178,7 +178,7 @@ namespace Stride.Core } /// - /// UnLoad all native dynamic library loaded previously by . + /// UnLoad all native dynamic library loaded previously by . /// public static void UnLoadAll() { diff --git a/sources/engine/Stride.Audio/AudioEngine.cs b/sources/engine/Stride.Audio/AudioEngine.cs index 6f52c1621..8e1644848 100644 --- a/sources/engine/Stride.Audio/AudioEngine.cs +++ b/sources/engine/Stride.Audio/AudioEngine.cs @@ -14,8 +14,8 @@ namespace Stride.Audio /// In current version, the audio engine necessarily creates its context on the default audio hardware of the device. /// The audio engine is required when creating or loading sounds. /// - /// The AudioEngine is Disposable. Call the function when you do not need to play sounds anymore to free memory allocated to the audio system. - /// A call to Dispose automatically stops and disposes all the , + /// The AudioEngine is Disposable. Call the function when you do not need to play sounds anymore to free memory allocated to the audio system. + /// A call to Dispose automatically stops and disposes all the , . public class AudioEngine : ComponentBase { public AudioListener DefaultListener; @@ -89,7 +89,7 @@ namespace Stride.Audio AudioLayer.Destroy(AudioDevice); } } - + /// /// The list of the sounds that have been paused by the call to and should be resumed by . /// @@ -101,7 +101,7 @@ namespace Stride.Audio internal uint AudioSampleRate { get; private set; } /// - /// Method that updates all the sounds play status. + /// Method that updates all the sounds play status. /// /// Should be called in same thread as user main thread. /// One or several of the sounds asked for play had invalid data (corrupted or unsupported formats). @@ -182,7 +182,7 @@ namespace Stride.Audio } } - private readonly List notDisposedSounds = new List(); + private readonly List notDisposedSounds = new List(); internal void RegisterSound(SoundBase newSound) { diff --git a/sources/engine/Stride.Audio/IPlayableSound.cs b/sources/engine/Stride.Audio/IPlayableSound.cs index b71ab410e..5420a8a2f 100644 --- a/sources/engine/Stride.Audio/IPlayableSound.cs +++ b/sources/engine/Stride.Audio/IPlayableSound.cs @@ -6,10 +6,10 @@ namespace Stride.Audio { /// /// Interface for a playable sound. - /// A playable sound can loop (ref ), be played (ref ), be paused (ref ), be resumed (ref ), + /// A playable sound can loop (ref ), be played (ref ), be paused (ref ), be resumed (ref ), /// be stopped (ref ) and be attenuated (ref ). /// To query the current state of a sound use the property. - /// To stop a sound after its currently loop use + /// To stop a sound after its currently loop set `IsLooping = false;` /// public interface IPlayableSound { diff --git a/sources/engine/Stride.Engine/Animations/AnimationCurve.cs b/sources/engine/Stride.Engine/Animations/AnimationCurve.cs index de1cd4253..17c1b929a 100644 --- a/sources/engine/Stride.Engine/Animations/AnimationCurve.cs +++ b/sources/engine/Stride.Engine/Animations/AnimationCurve.cs @@ -66,7 +66,7 @@ namespace Stride.Animations } /// - /// Shifts all animation keys by the specified time, adding it to all + /// Shifts all animation keys by the specified time, adding it to all /// /// The time span by which the keys should be shifted public virtual void ShiftKeys(CompressedTimeSpan shiftTimeSpan) { } diff --git a/sources/engine/Stride.Engine/Engine/Entity.cs b/sources/engine/Stride.Engine/Engine/Entity.cs index 301fcec02..f909c3e9a 100644 --- a/sources/engine/Stride.Engine/Engine/Entity.cs +++ b/sources/engine/Stride.Engine/Engine/Entity.cs @@ -160,10 +160,10 @@ namespace Stride.Engine } /// - /// Adds the specified component using the . + /// Adds the specified component to the entity. /// - /// The component. - /// component + /// The component to add. + /// Thrown if the component is null. public void Add(EntityComponent component) { Components.Add(component); diff --git a/sources/engine/Stride.Engine/Engine/SceneInstance.cs b/sources/engine/Stride.Engine/Engine/SceneInstance.cs index 945665819..cab3b67ca 100644 --- a/sources/engine/Stride.Engine/Engine/SceneInstance.cs +++ b/sources/engine/Stride.Engine/Engine/SceneInstance.cs @@ -23,17 +23,17 @@ namespace Stride.Engine public sealed class SceneInstance : EntityManager { /// - /// A property key to get the current scene from the . + /// A property key to get the current scene from the . /// public static readonly PropertyKey Current = new PropertyKey("SceneInstance.Current", typeof(SceneInstance)); /// - /// A property key to get the current render system from the . + /// A property key to get the current render system from the . /// public static readonly PropertyKey CurrentRenderSystem = new PropertyKey("SceneInstance.CurrentRenderSystem", typeof(SceneInstance)); /// - /// A property key to get the current visibility group from the . + /// A property key to get the current visibility group from the . /// public static readonly PropertyKey CurrentVisibilityGroup = new PropertyKey("SceneInstance.CurrentVisibilityGroup", typeof(SceneInstance)); diff --git a/sources/engine/Stride.Engine/Rendering/CameraComponentRendererExtensions.cs b/sources/engine/Stride.Engine/Rendering/CameraComponentRendererExtensions.cs index 702a37875..d7e8ce86e 100644 --- a/sources/engine/Stride.Engine/Rendering/CameraComponentRendererExtensions.cs +++ b/sources/engine/Stride.Engine/Rendering/CameraComponentRendererExtensions.cs @@ -10,7 +10,7 @@ namespace Stride.Rendering public static class CameraComponentRendererExtensions { /// - /// Property key to access the current collection of from . + /// Property key to access the current collection of from . /// public static readonly PropertyKey Current = new PropertyKey("CameraComponentRenderer.CurrentCamera", typeof(RenderContext)); diff --git a/sources/engine/Stride.Engine/Rendering/Compositing/GraphicsCompositor.cs b/sources/engine/Stride.Engine/Rendering/Compositing/GraphicsCompositor.cs index 107a97ee6..e995f8402 100644 --- a/sources/engine/Stride.Engine/Rendering/Compositing/GraphicsCompositor.cs +++ b/sources/engine/Stride.Engine/Rendering/Compositing/GraphicsCompositor.cs @@ -25,7 +25,7 @@ namespace Stride.Rendering.Compositing public class GraphicsCompositor : RendererBase { /// - /// A property key to get the current from the . + /// A property key to get the current from the . /// public static readonly PropertyKey Current = new PropertyKey("GraphicsCompositor.Current", typeof(GraphicsCompositor)); diff --git a/sources/engine/Stride.Engine/Rendering/Compositing/SceneCameraSlotCollection.cs b/sources/engine/Stride.Engine/Rendering/Compositing/SceneCameraSlotCollection.cs index 32264fd4c..4c6eb95a9 100644 --- a/sources/engine/Stride.Engine/Rendering/Compositing/SceneCameraSlotCollection.cs +++ b/sources/engine/Stride.Engine/Rendering/Compositing/SceneCameraSlotCollection.cs @@ -16,7 +16,7 @@ namespace Stride.Rendering.Compositing public sealed class SceneCameraSlotCollection : FastTrackingCollection { /// - /// Property key to access the current collection of from . + /// Property key to access the current collection of from . /// public static readonly PropertyKey Current = new PropertyKey("SceneCameraSlotCollection.Current", typeof(SceneCameraSlotCollection)); } diff --git a/sources/engine/Stride.Games/SDL/GameFormSDL.cs b/sources/engine/Stride.Games/SDL/GameFormSDL.cs index 2e3b1007b..4539f73f1 100644 --- a/sources/engine/Stride.Games/SDL/GameFormSDL.cs +++ b/sources/engine/Stride.Games/SDL/GameFormSDL.cs @@ -17,14 +17,14 @@ namespace Stride.Games { #region Initialization /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the 'GameForm' class. /// public GameFormSDL() : this(GameContext.ProductName) { } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the 'GameForm' class. /// /// The text. public GameFormSDL(string text) : base(text) diff --git a/sources/engine/Stride.Graphics/AppContextType.cs b/sources/engine/Stride.Graphics/AppContextType.cs index 03500ef0d..a767ba508 100644 --- a/sources/engine/Stride.Graphics/AppContextType.cs +++ b/sources/engine/Stride.Graphics/AppContextType.cs @@ -24,12 +24,12 @@ namespace Stride.Games { /// - /// Type of a . + /// Type of a `GameContext`. /// public enum AppContextType { /// - /// Game running on desktop in a form or . + /// Game running on desktop in a form or Control. /// Desktop, diff --git a/sources/engine/Stride.Graphics/Blend.cs b/sources/engine/Stride.Graphics/Blend.cs index 44c7cb6b4..bae46b4f8 100644 --- a/sources/engine/Stride.Graphics/Blend.cs +++ b/sources/engine/Stride.Graphics/Blend.cs @@ -69,12 +69,12 @@ namespace Stride.Graphics SourceAlphaSaturate = 11, /// - /// The data source is the blend factor set with . No pre-blend operation. + /// The data source is the blend factor set with . No pre-blend operation. /// BlendFactor = 14, /// - /// The data source is the blend factor set with . The pre-blend operation inverts the blend factor, generating 1 - blend_factor. + /// The data source is the blend factor set with . The pre-blend operation inverts the blend factor, generating 1 - blend_factor. /// InverseBlendFactor = 15, diff --git a/sources/engine/Stride.Graphics/BufferFlags.cs b/sources/engine/Stride.Graphics/BufferFlags.cs index ac14121e6..f47cd3259 100644 --- a/sources/engine/Stride.Graphics/BufferFlags.cs +++ b/sources/engine/Stride.Graphics/BufferFlags.cs @@ -13,7 +13,7 @@ namespace Stride.Graphics /// Creates a none buffer. /// /// - /// This is equivalent to . + /// This is equivalent to . /// None = 0, diff --git a/sources/engine/Stride.Graphics/CubeMapFace.cs b/sources/engine/Stride.Graphics/CubeMapFace.cs index db065fb63..62ade443a 100644 --- a/sources/engine/Stride.Graphics/CubeMapFace.cs +++ b/sources/engine/Stride.Graphics/CubeMapFace.cs @@ -5,7 +5,7 @@ using System; namespace Stride.Graphics { /// - /// Defines the faces of a cube map for . + /// Defines the faces of a cube map for Cube . /// public enum CubeMapFace { diff --git a/sources/engine/Stride.Graphics/CullMode.cs b/sources/engine/Stride.Graphics/CullMode.cs index 7e0d799e2..1ce88e4aa 100644 --- a/sources/engine/Stride.Graphics/CullMode.cs +++ b/sources/engine/Stride.Graphics/CullMode.cs @@ -8,7 +8,7 @@ namespace Stride.Graphics /// Indicates triangles facing a particular direction are not drawn. /// /// - /// This enumeration is part of a rasterizer-state object description (see ). + /// This enumeration is part of a rasterizer-state object description (see ). /// [DataContract] public enum CullMode diff --git a/sources/engine/Stride.Graphics/GeometricPrimitives/GeometricPrimitive.cs b/sources/engine/Stride.Graphics/GeometricPrimitives/GeometricPrimitive.cs index f2406c959..f2b2b3331 100644 --- a/sources/engine/Stride.Graphics/GeometricPrimitives/GeometricPrimitive.cs +++ b/sources/engine/Stride.Graphics/GeometricPrimitives/GeometricPrimitive.cs @@ -156,7 +156,8 @@ namespace Stride.Graphics.GeometricPrimitives } /// - /// A geometric primitive. Use , , , , , , . See to learn how to use it. + /// A geometric primitive. Use , , , , , , . + /// See Draw vertices to learn how to use it. /// public partial class GeometricPrimitive : GeometricPrimitive { diff --git a/sources/engine/Stride.Graphics/GraphicsPresenter.cs b/sources/engine/Stride.Graphics/GraphicsPresenter.cs index ce6e53b17..6fdba5d7a 100644 --- a/sources/engine/Stride.Graphics/GraphicsPresenter.cs +++ b/sources/engine/Stride.Graphics/GraphicsPresenter.cs @@ -28,7 +28,7 @@ using Stride.Core.ReferenceCounting; namespace Stride.Graphics { /// - /// This class is a frontend to and . + /// This class is a frontend to and . /// /// /// In order to create a new , a should have been initialized first. diff --git a/sources/engine/Stride.Graphics/MapMode.cs b/sources/engine/Stride.Graphics/MapMode.cs index 2b8efd1e4..d79370238 100644 --- a/sources/engine/Stride.Graphics/MapMode.cs +++ b/sources/engine/Stride.Graphics/MapMode.cs @@ -3,7 +3,7 @@ namespace Stride.Graphics { /// - /// Describes how the cpu is accessing a with the method. + /// Describes how the CPU is accessing a with the method. /// public enum MapMode { diff --git a/sources/engine/Stride.Graphics/MappedResource.cs b/sources/engine/Stride.Graphics/MappedResource.cs index 7a8ab6a1a..8806b29c6 100644 --- a/sources/engine/Stride.Graphics/MappedResource.cs +++ b/sources/engine/Stride.Graphics/MappedResource.cs @@ -3,7 +3,7 @@ namespace Stride.Graphics { /// - /// A GPU resource mapped for CPU access. This is returned by using + /// A GPU resource mapped for CPU access. This is returned by using /// public partial struct MappedResource { diff --git a/sources/engine/Stride.Graphics/PrimitiveQuad.cs b/sources/engine/Stride.Graphics/PrimitiveQuad.cs index d0541f22f..6d536322d 100644 --- a/sources/engine/Stride.Graphics/PrimitiveQuad.cs +++ b/sources/engine/Stride.Graphics/PrimitiveQuad.cs @@ -9,7 +9,7 @@ using Stride.Rendering; namespace Stride.Graphics { /// - /// Primitive quad use to draw an effect on a quad (fullscreen by default). This is directly accessible from the method. + /// Primitive quad use to draw an effect on a quad (fullscreen by default). This is directly accessible from the method. /// public class PrimitiveQuad : ComponentBase { diff --git a/sources/engine/Stride.Graphics/SDL/Window.cs b/sources/engine/Stride.Graphics/SDL/Window.cs index ee95bf5dd..91d55aa43 100644 --- a/sources/engine/Stride.Graphics/SDL/Window.cs +++ b/sources/engine/Stride.Graphics/SDL/Window.cs @@ -192,7 +192,7 @@ namespace Stride.Graphics.SDL } /// - /// Show window. The first time a window is shown we execute any actions from . + /// Show window. The first time a window is shown we execute any actions from 'HandleCreated' />. /// public void Show() { @@ -358,7 +358,7 @@ namespace Stride.Graphics.SDL // FIXME: We need to adapt the ClientSize to an actual Size to take into account borders. // FIXME: On Windows you do this by using AdjustWindowRect. // SDL.SDL_GetWindowBordersSize(sdlHandle, out var top, out var left, out var bottom, out var right); - // From SDL documentaion: Use this function to set the size of a window's client area. + // From SDL documentation: Use this function to set the size of a window's client area. SDL.SetWindowSize(sdlHandle, value.Width, value.Height); } } @@ -381,7 +381,7 @@ namespace Stride.Graphics.SDL } set { - // From SDL documentaion: Use this function to set the size of a window's client area. + // From SDL documentation: Use this function to set the size of a window's client area. SDL.SetWindowSize(sdlHandle, value.Width, value.Height); SDL.SetWindowPosition(sdlHandle, value.X, value.Y); } diff --git a/sources/engine/Stride.Graphics/SpriteExtensions.cs b/sources/engine/Stride.Graphics/SpriteExtensions.cs index bf5e866f9..527fc9d95 100644 --- a/sources/engine/Stride.Graphics/SpriteExtensions.cs +++ b/sources/engine/Stride.Graphics/SpriteExtensions.cs @@ -20,8 +20,8 @@ namespace Stride.Graphics /// The rotation to apply on the sprite /// The depth layer to which draw the sprite /// The sprite effect to apply on the sprite - /// This function must be called between the - /// and calls of the provided + /// This function must be called between the + /// and `SpriteBatch.End()` calls of the provided /// The provided frame index is not valid. /// The provided spriteBatch is null public static void Draw(this Sprite sprite, SpriteBatch spriteBatch, Vector2 position, float rotation = 0, float depthLayer = 0, SpriteEffects spriteEffects = SpriteEffects.None) @@ -40,8 +40,8 @@ namespace Stride.Graphics /// The scale factors to apply on the sprite /// The depth layer to which draw the sprite /// The sprite effect to apply on the sprite - /// This function must be called between the - /// and calls of the provided + /// This function must be called between the + /// and `SpriteBatch.End()` calls of the provided /// The provided frame index is not valid. /// The provided spriteBatch is null public static void Draw(this Sprite sprite, SpriteBatch spriteBatch, Vector2 position, Color color, Vector2 scales, float rotation = 0f, float depthLayer = 0, SpriteEffects spriteEffects = SpriteEffects.None) @@ -61,8 +61,8 @@ namespace Stride.Graphics /// The sprite batch used to draw the sprite. /// The world matrix of the sprite /// The color to apply on the sprite - /// This function must be called between the - /// and calls of the provided + /// This function must be called between the + /// and `SpriteBatch.End()` calls of the provided /// The provided frame index is not valid. /// The provided spriteBatch is null public static void Draw3D(this Sprite sprite, Sprite3DBatch spriteBatch, ref Matrix worldMatrix, ref Color4 color) diff --git a/sources/engine/Stride.Graphics/TextureDescription.cs b/sources/engine/Stride.Graphics/TextureDescription.cs index e92f2ff6f..b9608a073 100644 --- a/sources/engine/Stride.Graphics/TextureDescription.cs +++ b/sources/engine/Stride.Graphics/TextureDescription.cs @@ -86,7 +86,7 @@ namespace Stride.Graphics ///

Structure that specifies multisampling parameters for the texture. See .

/// /// - /// This field is only valid for . + /// This field is only valid for . /// public MultisampleCount MultisampleCount; diff --git a/sources/engine/Stride.Graphics/VertexElement.cs b/sources/engine/Stride.Graphics/VertexElement.cs index 84e4f8bda..f2d1c12d2 100644 --- a/sources/engine/Stride.Graphics/VertexElement.cs +++ b/sources/engine/Stride.Graphics/VertexElement.cs @@ -33,12 +33,12 @@ using Half = Stride.Core.Mathematics.Half; namespace Stride.Graphics { /// - /// A description of a single element for the input-assembler stage. This structure is related to . + /// A description of a single element for the input-assembler stage. This structure is related to . /// /// - /// Because requires to have the same , and , + /// Because requires to have the same , and , /// the structure encapsulates a set of for a particular slot, classification and instance data step rate. - /// Unlike the default , this structure accepts a semantic name with a postfix number that will be automatically extracted to the semantic index. + /// Unlike the default , this structure accepts a semantic name with a postfix number that will be automatically extracted to the semantic index. /// /// [DataContract] diff --git a/sources/engine/Stride.Input/PointerDeviceState.cs b/sources/engine/Stride.Input/PointerDeviceState.cs index c1853f8cb..1e6dc2cdb 100644 --- a/sources/engine/Stride.Input/PointerDeviceState.cs +++ b/sources/engine/Stride.Input/PointerDeviceState.cs @@ -70,7 +70,7 @@ namespace Stride.Input } /// - /// Processes a , converting it to a . Also calls and updates + /// Processes a , converting it to a . Also calls and updates current /// /// public PointerEvent ProcessPointerEvent(InputEvent evt) @@ -85,7 +85,7 @@ namespace Stride.Input } /// - /// Updates a pointer event with position / type / id set and updates the storted pointer data + /// Updates a pointer event with position / type / id set and updates the stored pointer data /// /// public void UpdatePointerState(PointerEvent evt, bool updateDelta = true) @@ -129,7 +129,7 @@ namespace Stride.Input } /// - /// Retrueves a pointer data structure unqiue to the given pointer ID + /// Retrieves a pointer data structure unique to the given pointer ID /// /// /// diff --git a/sources/engine/Stride.Rendering/Rendering/Compositing/SceneRendererBase.cs b/sources/engine/Stride.Rendering/Rendering/Compositing/SceneRendererBase.cs index 2fa553b29..e3c4ed6a2 100644 --- a/sources/engine/Stride.Rendering/Rendering/Compositing/SceneRendererBase.cs +++ b/sources/engine/Stride.Rendering/Rendering/Compositing/SceneRendererBase.cs @@ -7,7 +7,7 @@ using Stride.Core.Annotations; namespace Stride.Rendering.Compositing { /// - /// Describes the code part of a . + /// Describes the code part of a `GraphicsCompositor`. /// [DataContract(Inherited = true)] public abstract class SceneRendererBase : RendererCoreBase, ISceneRenderer diff --git a/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollection.cs b/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollection.cs index 61a25e83c..6810b4a1d 100644 --- a/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollection.cs +++ b/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollection.cs @@ -8,7 +8,7 @@ namespace Stride.Rendering { /// /// A collection of that is itself a handling automatically - /// and . + /// and . /// /// Type of the . [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] diff --git a/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollectionBase.cs b/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollectionBase.cs index 464f05c37..ec7204b99 100644 --- a/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollectionBase.cs +++ b/sources/engine/Stride.Rendering/Rendering/GraphicsRendererCollectionBase.cs @@ -14,7 +14,7 @@ namespace Stride.Rendering { /// /// A collection of that is itself a handling automatically - /// and . + /// and . /// /// Type of the . [DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)] diff --git a/sources/engine/Stride.Rendering/Rendering/Images/ImageEffect.cs b/sources/engine/Stride.Rendering/Rendering/Images/ImageEffect.cs index 37f21a3a8..c04fcfbff 100644 --- a/sources/engine/Stride.Rendering/Rendering/Images/ImageEffect.cs +++ b/sources/engine/Stride.Rendering/Rendering/Images/ImageEffect.cs @@ -57,7 +57,7 @@ namespace Stride.Rendering.Images /// The context. /// The name. /// context - protected ImageEffect(RenderContext context, string name = null) + protected ImageEffect(RenderContext context, string name = null) : this(name) { Initialize(context); @@ -169,7 +169,7 @@ namespace Stride.Rendering.Images /// Binds a set of viewports to the rasterizer stage. /// /// The set of viewports to bind. - /// Only scissors can be used simultaneously + /// Only 's `MaxViewportAndScissorRectangleCount` scissors can be used simultaneously public void SetViewports(ReadOnlySpan values) { if (values.Length > CommandList.MaxViewportAndScissorRectangleCount) @@ -202,7 +202,7 @@ namespace Stride.Rendering.Images /// Binds a set of scissor rectangles to the rasterizer stage. /// /// The set of scissor rectangles to bind. - /// Only viewports can be used simultaneously + /// Only 's `MaxViewportAndScissorRectangleCount` viewports can be used simultaneously public void SetScissorRectangles(ReadOnlySpan values) { if (values.Length > CommandList.MaxViewportAndScissorRectangleCount) @@ -415,7 +415,7 @@ namespace Stride.Rendering.Images } /// - /// Gets a render target with the specified description, scoped for the duration of the . + /// Gets a render target with the specified description, scoped for the duration of the . /// /// A new instance of texture. protected Texture NewScopedRenderTarget2D(TextureDescription description) @@ -426,7 +426,7 @@ namespace Stride.Rendering.Images } /// - /// Gets a render target output for the specified description with a single mipmap, scoped for the duration of the . + /// Gets a render target output for the specified description with a single mipmap, scoped for the duration of the . /// /// The width. /// The height. @@ -444,7 +444,7 @@ namespace Stride.Rendering.Images } /// - /// Gets a render target output for the specified description, scoped for the duration of the . + /// Gets a render target output for the specified description, scoped for the duration of the . /// /// The width. /// The height. diff --git a/sources/engine/Stride.Rendering/Rendering/Images/ImageEffectShader.cs b/sources/engine/Stride.Rendering/Rendering/Images/ImageEffectShader.cs index 55ad93b0f..bf4d7e3ba 100644 --- a/sources/engine/Stride.Rendering/Rendering/Images/ImageEffectShader.cs +++ b/sources/engine/Stride.Rendering/Rendering/Images/ImageEffectShader.cs @@ -95,7 +95,7 @@ namespace Stride.Rendering.Images } /// - /// Sets the default parameters (called at constructor time and if is called) + /// Sets the default parameters (called at constructor time and if is called) /// protected override void SetDefaultParameters() { diff --git a/sources/engine/Stride.Rendering/Rendering/Lights/ForwardLightingRenderFeature.cs b/sources/engine/Stride.Rendering/Rendering/Lights/ForwardLightingRenderFeature.cs index 59947f815..b4f876a04 100644 --- a/sources/engine/Stride.Rendering/Rendering/Lights/ForwardLightingRenderFeature.cs +++ b/sources/engine/Stride.Rendering/Rendering/Lights/ForwardLightingRenderFeature.cs @@ -25,7 +25,7 @@ namespace Stride.Rendering.Lights public class ForwardLightingRenderFeature : SubRenderFeature { /// - /// Property key to access the current collection of from . + /// Property key to access the current collection of `CameraComponent` from . /// public static readonly PropertyKey CurrentLights = new PropertyKey("ForwardLightingRenderFeature.CurrentLights", typeof(ForwardLightingRenderFeature)); diff --git a/sources/engine/Stride.Rendering/Rendering/Lights/LightDirectionalShadowMap.cs b/sources/engine/Stride.Rendering/Rendering/Lights/LightDirectionalShadowMap.cs index 4e96083ec..6fcb78f2c 100644 --- a/sources/engine/Stride.Rendering/Rendering/Lights/LightDirectionalShadowMap.cs +++ b/sources/engine/Stride.Rendering/Rendering/Lights/LightDirectionalShadowMap.cs @@ -88,7 +88,7 @@ namespace Stride.Rendering.Lights public sealed class PartitionManual : PartitionModeBase { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// public PartitionManual() { diff --git a/sources/engine/Stride.Rendering/Rendering/Lights/LightSkybox.cs b/sources/engine/Stride.Rendering/Rendering/Lights/LightSkybox.cs index f932ba32b..2588a5e7c 100644 --- a/sources/engine/Stride.Rendering/Rendering/Lights/LightSkybox.cs +++ b/sources/engine/Stride.Rendering/Rendering/Lights/LightSkybox.cs @@ -9,7 +9,7 @@ using Stride.Rendering.Skyboxes; namespace Stride.Rendering.Lights { /// - /// A light coming from a skybox. The must be set on the entity in order to see a skybox. + /// A light coming from a skybox. The `BackgroundComponent` must be set on the entity in order to see a skybox. /// [DataContract("LightSkybox")] [Display("Skybox")] diff --git a/sources/engine/Stride.Rendering/Rendering/RenderEffect.cs b/sources/engine/Stride.Rendering/Rendering/RenderEffect.cs index 3828549b7..e6ef4d4f1 100644 --- a/sources/engine/Stride.Rendering/Rendering/RenderEffect.cs +++ b/sources/engine/Stride.Rendering/Rendering/RenderEffect.cs @@ -7,7 +7,7 @@ using Stride.Graphics; namespace Stride.Rendering { /// - /// Instantiation of an Effect for a given . + /// Instantiation of an Effect for a given . /// public class RenderEffect { diff --git a/sources/engine/Stride.Rendering/Rendering/RendererCoreBase.cs b/sources/engine/Stride.Rendering/Rendering/RendererCoreBase.cs index 58747e1fd..979faf4e6 100644 --- a/sources/engine/Stride.Rendering/Rendering/RendererCoreBase.cs +++ b/sources/engine/Stride.Rendering/Rendering/RendererCoreBase.cs @@ -47,7 +47,7 @@ namespace Stride.Rendering } /// - /// Gets or sets a value indicating whether this is enabled. + /// Gets or sets a value indicating whether this is enabled. /// /// true if enabled; otherwise, false. /// Enabled if checked, disabled otherwise @@ -151,7 +151,7 @@ namespace Stride.Rendering } /// - /// Gets a render target with the specified description, scoped for the duration of the . + /// Gets a render target with the specified description, scoped for the duration of the . /// /// The description of the buffer to allocate /// The pixel format seen in shader @@ -163,7 +163,7 @@ namespace Stride.Rendering } /// - /// Gets a render target with the specified description, scoped for the duration of the . + /// Gets a render target with the specified description, scoped for the duration of the . /// /// A new instance of texture. protected Buffer NewScopedTypedBuffer(int count, PixelFormat viewFormat, bool isUnorderedAccess, GraphicsResourceUsage usage = GraphicsResourceUsage.Default)