fix: Xml comments fix 5 (#2419)

VaclavElias · web-flow · commit 1cc9c2414f9c · 2024-09-01T21:04:44.000+02:00
* fix: Correct reference added to BoundingBox

* fix: cref corrected - removed full stop

* fix: cref for AudioEmitterComponent corrected

* fix: param fixed from rotation to scale

* fix: RaiseException doesn't exist, most likely it should be SetException, which is present

* fix: cref corrected with full namespace

* fix: cref references corrected

* chore: Reversing the update because it's not working

* fix: Incorrect reference

* fix: The C# reference itself doesn't exist but the reference seems ok

* fix: Correcting the references

* fix: Fixed xml comment

* fix: xml summary corrected

* fix: cref reversed back, but added full namespace

* fix: Fixing see xml tag with appropriate html link to our manual
diff --git a/sources/assets/Stride.Core.Assets/Bundle.cs b/sources/assets/Stride.Core.Assets/Bundle.cs
@@ -33,7 +33,7 @@ public sealed class Bundle
         public List<string> Dependencies { get; } = new List<string>();
 
         /// <summary>
-        /// Gets the output group (used in conjonction with <see cref="ProjectBuildProfile.OutputGroupDirectories"/> to control where file will be put).
+        /// Gets the output group (used in conjonction with `ProjectBuildProfile.OutputGroupDirectories` to control where file will be put).
         /// </summary>
         /// <value>
         /// The output group.
diff --git a/sources/assets/Stride.Core.Assets/OverrideUpgraderHint.cs b/sources/assets/Stride.Core.Assets/OverrideUpgraderHint.cs
@@ -18,7 +18,7 @@ public enum OverrideUpgraderHint
         Derived,
 
         /// <summary>
-        /// The upgrader is performed on the base asset of an asset being upgraded (<see cref="Asset.Base"/> or <see cref="Asset.BaseParts"/>)
+        /// The upgrader is performed on the base asset of an asset being upgraded (<see cref="AssetItem"/> or <see cref="Assets.BasePart"/>)
         /// </summary>
         Base
     }
diff --git a/sources/core/Stride.Core.Mathematics/CollisionHelper.cs b/sources/core/Stride.Core.Mathematics/CollisionHelper.cs
@@ -895,7 +895,7 @@ public static bool RayIntersectsBox(ref readonly Ray ray, ref readonly BoundingB
         }
 
         /// <summary>
-        /// Determines whether there is an intersection between a <see cref="Stride.Core.Mathematics.Ray"/> and a <see cref="Stride.Core.Mathematics.Plane"/>.
+        /// Determines whether there is an intersection between a <see cref="Stride.Core.Mathematics.Ray"/> and a <see cref="Stride.Core.Mathematics.BoundingBox"/>.
         /// </summary>
         /// <param name="ray">The ray to test.</param>
         /// <param name="box">The box to test.</param>
diff --git a/sources/core/Stride.Core.MicroThreading/MicroThread.cs b/sources/core/Stride.Core.MicroThreading/MicroThread.cs
@@ -92,7 +92,7 @@ public long Priority
         /// <summary>
         /// Gets the exception that was thrown by this <see cref="MicroThread"/>.
         /// </summary>
-        /// It could come from either internally, or from <see cref="RaiseException"/> if it was successfully processed.
+        /// It could come from either internally, or from <see cref="SetException"/> if it was successfully processed.
         /// <value>The exception.</value>
         public Exception Exception { get; private set; }
 
diff --git a/sources/engine/Stride.Engine/Animations/AnimationCurve.cs b/sources/engine/Stride.Engine/Animations/AnimationCurve.cs
@@ -66,7 +66,7 @@ protected AnimationCurve()
         }
 
         /// <summary>
-        /// Shifts all animation keys by the specified time, adding it to all <see cref="KeyFrameData{T}.Time". />
+        /// Shifts all animation keys by the specified time, adding it to all <see cref="KeyFrameData{T}.Time" />
         /// </summary>
         /// <param name="shiftTimeSpan">The time span by which the keys should be shifted</param>
         public virtual void ShiftKeys(CompressedTimeSpan shiftTimeSpan) { }
diff --git a/sources/engine/Stride.Engine/Audio/AudioEmitterSoundController.cs b/sources/engine/Stride.Engine/Audio/AudioEmitterSoundController.cs
@@ -17,7 +17,7 @@ namespace Stride.Audio
     /// <remarks>
     /// <para>
     /// Instances of this class can not be directly created by the user, but need to queried from an <see cref="AudioEmitterComponent"/>
-    /// instance using the readonly <see cref="AudioEmitterComponent.Item(string)"/> indexer.
+    /// instance using the readonly <see cref="AudioEmitterComponent.this[string]"/> indexer.
     /// </para>
     /// <para>
     /// An instance <see cref="AudioEmitterSoundController"/> is not valid anymore if any of those situations arrives:
diff --git a/sources/engine/Stride.Engine/Engine/AudioEmitterComponent.cs b/sources/engine/Stride.Engine/Engine/AudioEmitterComponent.cs
@@ -24,7 +24,7 @@ namespace Stride.Engine
     /// Use the <see cref="Sounds"/> dictionary to associate or dissociate a <see cref="SoundBase"/> to the emitter component.
     /// Each SoundBase associated to the emitter component can be controlled (played, paused, stopped, ...) independently for the others.
     /// Once attached to the emitter component, a SoundBase is controlled using a <see cref="AudioEmitterSoundController"/>.
-    /// To get the AudioEmitterSoundController associated to a SoundBase use the readonly <see cref="AudioEmitterComponent.Item(string)"/> indexer.
+    /// To get the AudioEmitterSoundController associated to a SoundBase use the readonly <see cref="AudioEmitterComponent.this[string]"/> indexer.
     /// </para>
     /// </remarks>
     [Display("Audio emitter", Expand = ExpandRule.Once)]
@@ -128,7 +128,7 @@ public ControllerCollectionChangedEventArgs(Entity entity, AudioEmitterSoundCont
 
         /// <summary>
         /// Attach a <see cref="SoundBase"/> to this emitter component.
-        /// Once attached a <see cref="AudioEmitterSoundController"/> can be queried using readonly <see cref="AudioEmitterComponent.Item(string)"/> indexer to control the attached SoundBase.
+        /// Once attached a <see cref="AudioEmitterSoundController"/> can be queried using readonly <see cref="AudioEmitterComponent.this[string]"/> indexer to control the attached SoundBase.
         /// </summary>
         /// <param name="sound">The SoundBase to attach</param>
         /// <exception cref="ArgumentNullException">The provided <paramref name="sound"/> is null.</exception>
diff --git a/sources/engine/Stride.Engine/Engine/Design/EffectCompilationMode.cs b/sources/engine/Stride.Engine/Engine/Design/EffectCompilationMode.cs
@@ -7,7 +7,7 @@
 namespace Stride.Engine.Design
 {
     /// <summary>
-    /// Defines how <see cref="EffectCompilerFactory.CreateEffectCompiler"/> tries to create compiler.
+    /// Defines how <see cref="Stride.Shaders.Compiler.EffectCompilerFactory.CreateEffectCompiler"/> tries to create compiler.
     /// </summary>
     [Flags]
     public enum EffectCompilationMode
diff --git a/sources/engine/Stride.Engine/Engine/Entity.cs b/sources/engine/Stride.Engine/Engine/Entity.cs
@@ -54,7 +54,7 @@ public Entity(string name)
         /// <param name="name">The name to give to the entity</param>
         /// <param name="position">The initial position of the entity</param>
         /// <param name="rotation">The initial rotation of the entity</param>
-        /// <param name="rotation">The initial scale of the entity</param>
+        /// <param name="scale">The initial scale of the entity</param>
         public Entity(string name = null, Vector3 position = default, Quaternion? rotation = null, Vector3? scale = null)
             : this(name, false)
         {
diff --git a/sources/engine/Stride.Engine/Engine/EntityManager.cs b/sources/engine/Stride.Engine/Engine/EntityManager.cs
@@ -161,8 +161,8 @@ public TProcessor GetProcessor<TProcessor>() where TProcessor : EntityProcessor
 
         /// <summary>
         /// Removes the entity from the <see cref="EntityManager" />.
-        /// It works weither entity has a parent or not.
-        /// In conjonction with <see cref="HierarchicalProcessor" />, it will remove child entities as well.
+        /// It works either entity has a parent or not.
+        /// In conjonction with <see cref="EntityProcessor" />, it will remove child entities as well.
         /// </summary>
         /// <param name="entity">The entity.</param>
         public void Remove(Entity entity)
@@ -408,7 +408,7 @@ private void OnProcessorAdded(EntityProcessor processor)
 
         private void OnProcessorRemoved(EntityProcessor processor)
         {
-            // Remove the procsesor from any list
+            // Remove the processor from any list
             foreach (var componentTypeAndProcessors in MapComponentTypeToProcessors)
             {
                 var processorList = componentTypeAndProcessors.Value;
diff --git a/sources/engine/Stride.Engine/Engine/InstancingUserBuffer.cs b/sources/engine/Stride.Engine/Engine/InstancingUserBuffer.cs
@@ -22,7 +22,7 @@ public class InstancingUserBuffer : IInstancing
         public virtual int InstanceCount { get; set; }
 
         /// <summary>
-        /// The bounding box of the world matrices, updated automatically by the <see cref="InstancingProcessor"/>.
+        /// The bounding box of the world matrices, updated automatically by the <see cref="Stride.Engine.Processors.InstancingProcessor"/>.
         /// </summary>
         [DataMemberIgnore]
         public virtual BoundingBox BoundingBox { get; set; } = BoundingBox.Empty;
diff --git a/sources/engine/Stride.Engine/Profiling/GameProfilingSystem.cs b/sources/engine/Stride.Engine/Profiling/GameProfilingSystem.cs
@@ -67,7 +67,7 @@ public class GameProfilingSystem : GameSystemBase
         private uint drawCallsCount;
 
         /// <summary>
-        /// The render target where the profiling results should be rendered into. If null, the <see cref="Game.GraphicsDevice.Presenter.BackBuffer"/> is used.
+        /// The render target where the profiling results should be rendered into. If null, the <see cref="Stride.Graphics.GraphicsPresenter.BackBuffer"/> is used.
         /// </summary>
         public Texture RenderTarget { get; set; }
 
diff --git a/sources/engine/Stride.Engine/Updater/ArrayUpdateResolver.cs b/sources/engine/Stride.Engine/Updater/ArrayUpdateResolver.cs
@@ -6,7 +6,7 @@
 namespace Stride.Updater
 {
     /// <summary>
-    /// Resolver for <see cref="T[]"/> in property path.
+    /// Resolver for <see cref="Array"/> with elements of type <typeparamref name="T"/>.
     /// </summary>
     /// <typeparam name="T">The type of array items.</typeparam>
     public class ArrayUpdateResolver<T> : UpdateMemberResolver
diff --git a/sources/engine/Stride.Graphics/CommandList.cs b/sources/engine/Stride.Graphics/CommandList.cs
@@ -143,7 +143,9 @@ public void SetViewports(int viewportCount, Viewport[] values)
         }
 
         /// <summary>
-        /// Binds a single scissor rectangle to the rasterizer stage. See <see cref="Render+states"/> to learn how to use it.
+        /// Binds a single scissor rectangle to the rasterizer stage.
+        /// See <see href="https://doc.stride3d.net/latest/en/manual/graphics/low-level-api/textures-and-render-textures.html#code-set-the-scissor">Set the scissor</see>
+        /// in the manual for more information.
         /// </summary>
         /// <param name="rectangle">The scissor rectangle.</param>
         public void SetScissorRectangle(Rectangle rectangle)
@@ -155,7 +157,9 @@ public void SetScissorRectangle(Rectangle rectangle)
         }
 
         /// <summary>
-        /// Binds a set of scissor rectangles to the rasterizer stage. See <see cref="Render+states"/> to learn how to use it.
+        /// Binds a set of scissor rectangles to the rasterizer stage.
+        /// See <see href="https://doc.stride3d.net/latest/en/manual/graphics/low-level-api/textures-and-render-textures.html#code-set-the-scissor">Set the scissor</see>
+        /// in the manual for more information.
         /// </summary>
         /// <param name="scissorRectangles">The set of scissor rectangles to bind.</param>
         public void SetScissorRectangles(Rectangle[] scissorRectangles)
@@ -164,7 +168,9 @@ public void SetScissorRectangles(Rectangle[] scissorRectangles)
         }
 
         /// <summary>
-        /// Binds a set of scissor rectangles to the rasterizer stage. See <see cref="Render+states"/> to learn how to use it.
+        /// Binds a set of scissor rectangles to the rasterizer stage.
+        /// See <see href="https://doc.stride3d.net/latest/en/manual/graphics/low-level-api/textures-and-render-textures.html#code-set-the-scissor">Set the scissor</see>
+        /// in the manual for more information.
         /// </summary>
         /// <param name="scissorCount">The number of scissor rectangles to bind.</param>
         /// <param name="scissorRectangles">The set of scissor rectangles to bind.</param>
@@ -180,7 +186,9 @@ public void SetScissorRectangles(int scissorCount, Rectangle[] scissorRectangles
         }
 
         /// <summary>
-        /// Binds a depth-stencil buffer and a single render target to the output-merger stage. See <see cref="Textures+and+render+targets"/> to learn how to use it.
+        /// Binds a depth-stencil buffer and a single render target to the output-merger stage.
+        /// See <see href="https://doc.stride3d.net/latest/en/manual/graphics/low-level-api/textures-and-render-textures.html#code-use-a-render-target">Use a render target</see>
+        /// in the manual for more information.
         /// </summary>
         /// <param name="depthStencilView">A view of the depth-stencil buffer to bind.</param>
         /// <param name="renderTargetView">A view of the render target to bind.</param>
diff --git a/sources/engine/Stride.Graphics/GraphicsDeviceExtensions.cs b/sources/engine/Stride.Graphics/GraphicsDeviceExtensions.cs
@@ -2,7 +2,6 @@
 // Distributed under the MIT license. See the LICENSE.md file in the project root for more information.
 
 using System;
-using System.Collections.Generic;
 
 using Stride.Core.Mathematics;
 using Stride.Rendering;
@@ -17,9 +16,9 @@ public static class GraphicsDeviceExtensions
         /// <summary>
         /// Draws a fullscreen quad with the specified effect and parameters.
         /// </summary>
-        /// <param name="device">The device.</param>
-        /// <param name="effectInstance">The effect instance.</param>
-        /// <exception cref="System.ArgumentNullException">effect</exception>
+        /// <param name="graphicsContext">The graphics context used for drawing.</param>
+        /// <param name="effectInstance">The effect instance to apply when drawing the quad.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown when <paramref name="effectInstance"/> is <c>null</c>.</exception>
         public static void DrawQuad(this GraphicsContext graphicsContext, EffectInstance effectInstance)
         {
             if (effectInstance == null) throw new ArgumentNullException("effectInstance");
diff --git a/sources/engine/Stride.Rendering/Rendering/RenderContext.cs b/sources/engine/Stride.Rendering/Rendering/RenderContext.cs
@@ -89,7 +89,7 @@ internal RenderContext(IServiceRegistry services)
         public RenderSystem RenderSystem { get; set; }
 
         /// <summary>
-        /// The current visibility group from the <see cref="SceneInstance"/> and <see cref="RenderSystem"/>.
+        /// The current visibility group from the <see cref="Stride.Engine.SceneInstance"/> and <see cref="RenderSystem"/>.
         /// </summary>
         public VisibilityGroup VisibilityGroup { get; set; }
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public enum OverrideUpgraderHint`
`18`	`18`	`Derived,`
`19`	`19`
`20`	`20`	`/// <summary>`
`21`		`- /// The upgrader is performed on the base asset of an asset being upgraded (<see cref="Asset.Base"/> or <see cref="Asset.BaseParts"/>)`
	`21`	`+ /// The upgrader is performed on the base asset of an asset being upgraded (<see cref="AssetItem"/> or <see cref="Assets.BasePart"/>)`
`22`	`22`	`/// </summary>`
`23`	`23`	`Base`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -895,7 +895,7 @@ public static bool RayIntersectsBox(ref readonly Ray ray, ref readonly BoundingB`
`895`	`895`	`}`
`896`	`896`
`897`	`897`	`/// <summary>`
`898`		`- /// Determines whether there is an intersection between a <see cref="Stride.Core.Mathematics.Ray"/> and a <see cref="Stride.Core.Mathematics.Plane"/>.`
	`898`	`+ /// Determines whether there is an intersection between a <see cref="Stride.Core.Mathematics.Ray"/> and a <see cref="Stride.Core.Mathematics.BoundingBox"/>.`
`899`	`899`	`/// </summary>`
`900`	`900`	`/// <param name="ray">The ray to test.</param>`
`901`	`901`	`/// <param name="box">The box to test.</param>`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ protected AnimationCurve()`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`/// <summary>`
`69`		`- /// Shifts all animation keys by the specified time, adding it to all <see cref="KeyFrameData{T}.Time". />`
	`69`	`+ /// Shifts all animation keys by the specified time, adding it to all <see cref="KeyFrameData{T}.Time" />`
`70`	`70`	`/// </summary>`
`71`	`71`	`/// <param name="shiftTimeSpan">The time span by which the keys should be shifted</param>`
`72`	`72`	`public virtual void ShiftKeys(CompressedTimeSpan shiftTimeSpan) { }`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`namespace Stride.Engine.Design`
`8`	`8`	`{`
`9`	`9`	`/// <summary>`
`10`		`- /// Defines how <see cref="EffectCompilerFactory.CreateEffectCompiler"/> tries to create compiler.`
	`10`	`+ /// Defines how <see cref="Stride.Shaders.Compiler.EffectCompilerFactory.CreateEffectCompiler"/> tries to create compiler.`
`11`	`11`	`/// </summary>`
`12`	`12`	`[Flags]`
`13`	`13`	`public enum EffectCompilationMode`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public Entity(string name)`
`54`	`54`	`/// <param name="name">The name to give to the entity</param>`
`55`	`55`	`/// <param name="position">The initial position of the entity</param>`
`56`	`56`	`/// <param name="rotation">The initial rotation of the entity</param>`
`57`		`- /// <param name="rotation">The initial scale of the entity</param>`
	`57`	`+ /// <param name="scale">The initial scale of the entity</param>`
`58`	`58`	`public Entity(string name = null, Vector3 position = default, Quaternion? rotation = null, Vector3? scale = null)`
`59`	`59`	`: this(name, false)`
`60`	`60`	`{`