* 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
This commit is contained in:
Vaclav Elias 2024-09-01 20:04:44 +01:00 коммит произвёл GitHub
Родитель 32e341ca05
Коммит 1cc9c2414f
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
16 изменённых файлов: 32 добавлений и 25 удалений

Просмотреть файл

@ -33,7 +33,7 @@ namespace Stride.Core.Assets
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.

Просмотреть файл

@ -18,7 +18,7 @@ namespace Stride.Core.Assets
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
}

Просмотреть файл

@ -895,7 +895,7 @@ namespace Stride.Core.Mathematics
}
/// <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>

Просмотреть файл

@ -92,7 +92,7 @@ namespace Stride.Core.MicroThreading
/// <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; }

Просмотреть файл

@ -66,7 +66,7 @@ namespace Stride.Animations
}
/// <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) { }

Просмотреть файл

@ -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:

Просмотреть файл

@ -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 @@ namespace Stride.Engine
/// <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>

Просмотреть файл

@ -7,7 +7,7 @@ using Stride.Rendering;
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

Просмотреть файл

@ -54,7 +54,7 @@ namespace Stride.Engine
/// <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)
{

Просмотреть файл

@ -161,8 +161,8 @@ namespace Stride.Engine
/// <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 @@ namespace Stride.Engine
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;

Просмотреть файл

@ -22,7 +22,7 @@ namespace Stride.Engine
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;

Просмотреть файл

@ -67,7 +67,7 @@ namespace Stride.Profiling
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; }

Просмотреть файл

@ -6,7 +6,7 @@ using System.Globalization;
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

Просмотреть файл

@ -143,7 +143,9 @@ namespace Stride.Graphics
}
/// <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 @@ namespace Stride.Graphics
}
/// <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 @@ namespace Stride.Graphics
}
/// <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 @@ namespace Stride.Graphics
}
/// <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>

Просмотреть файл

@ -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 @@ namespace Stride.Graphics
/// <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");

Просмотреть файл

@ -89,7 +89,7 @@ namespace Stride.Rendering
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; }