mirror of
https://github.com/SK-la/osu-framework.git
synced 2026-03-15 03:20:30 +00:00
Fix IDE0001 in xml doc
This commit is contained in:
@@ -12,7 +12,7 @@ using osu.Framework.Extensions.TypeExtensions;
|
||||
namespace osu.Framework.Allocation
|
||||
{
|
||||
/// <summary>
|
||||
/// Marks a method as the (potentially asynchronous) initialization method of a <see cref="osu.Framework.Graphics.Drawable"/>, allowing for automatic injection of dependencies via the parameters of the method.
|
||||
/// Marks a method as the (potentially asynchronous) initialization method of a <see cref="Graphics.Drawable"/>, allowing for automatic injection of dependencies via the parameters of the method.
|
||||
/// </summary>
|
||||
[MeansImplicitUse(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
|
||||
@@ -74,7 +74,7 @@ namespace osu.Framework.Allocation
|
||||
=> CacheAs(type, info, instance, false);
|
||||
|
||||
/// <summary>
|
||||
/// Caches an instance of a type as its most derived type. This instance will be returned each time you <see cref="DependencyContainer.Get(Type)"/>.
|
||||
/// Caches an instance of a type as its most derived type. This instance will be returned each time you <see cref="Get(Type)"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This should only be used when it is guaranteed that the internal state of the type will remain consistent through retrieval.
|
||||
@@ -85,7 +85,7 @@ namespace osu.Framework.Allocation
|
||||
=> CacheValue(instance, default);
|
||||
|
||||
/// <summary>
|
||||
/// Caches an instance of a type as its most derived type. This instance will be returned each time you <see cref="DependencyContainer.Get(Type)"/>.
|
||||
/// Caches an instance of a type as its most derived type. This instance will be returned each time you <see cref="Get(Type)"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This should only be used when it is guaranteed that the internal state of the type will remain consistent through retrieval.
|
||||
@@ -102,7 +102,7 @@ namespace osu.Framework.Allocation
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Caches an instance of a type as a type of <typeparamref name="T"/>. This instance will be returned each time you <see cref="DependencyContainer.Get(Type)"/>.
|
||||
/// Caches an instance of a type as a type of <typeparamref name="T"/>. This instance will be returned each time you <see cref="Get(Type)"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This should only be used when it is guaranteed that the internal state of the type will remain consistent through retrieval.
|
||||
@@ -113,7 +113,7 @@ namespace osu.Framework.Allocation
|
||||
=> CacheValueAs(instance, default);
|
||||
|
||||
/// <summary>
|
||||
/// Caches an instance of a type as a type of <typeparamref name="T"/>. This instance will be returned each time you <see cref="DependencyContainer.Get(Type)"/>.
|
||||
/// Caches an instance of a type as a type of <typeparamref name="T"/>. This instance will be returned each time you <see cref="Get(Type)"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This should only be used when it is guaranteed that the internal state of the type will remain consistent through retrieval.
|
||||
|
||||
@@ -132,7 +132,7 @@ namespace osu.Framework.Audio.Mixing.Bass
|
||||
/// </summary>
|
||||
/// <remarks>See: <see cref="ManagedBass.Bass.ChannelIsActive"/>.</remarks>
|
||||
/// <param name="channel">The channel to get the state of.</param>
|
||||
/// <returns><see cref="ManagedBass.PlaybackState"/> indicating the state of the channel.</returns>
|
||||
/// <returns><see cref="PlaybackState"/> indicating the state of the channel.</returns>
|
||||
public PlaybackState ChannelIsActive(IBassAudioChannel channel)
|
||||
{
|
||||
// The audio channel's state tells us whether it's stalled or stopped.
|
||||
@@ -215,7 +215,7 @@ namespace osu.Framework.Audio.Mixing.Bass
|
||||
/// <summary>
|
||||
/// Sets up a synchroniser on a mixer source channel.
|
||||
/// </summary>
|
||||
/// <remarks>See: <see cref="ManagedBass.Mix.BassMix.ChannelSetSync(int, SyncFlags, long, SyncProcedure, IntPtr)"/>.</remarks>
|
||||
/// <remarks>See: <see cref="BassMix.ChannelSetSync(int, SyncFlags, long, SyncProcedure, IntPtr)"/>.</remarks>
|
||||
/// <param name="channel">The <see cref="IBassAudioChannel"/> to set up the synchroniser for.</param>
|
||||
/// <param name="type">The type of sync.</param>
|
||||
/// <param name="parameter">The sync parameters, depending on the sync type.</param>
|
||||
|
||||
@@ -46,7 +46,7 @@ namespace osu.Framework.Graphics.Audio
|
||||
private float resolution = 1;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the amount of <see cref="Framework.Audio.Track.Waveform.Point"/>'s displayed relative to <see cref="Drawable.DrawWidth">DrawWidth</see>.
|
||||
/// Gets or sets the amount of <see cref="Waveform.Point"/>'s displayed relative to <see cref="Drawable.DrawWidth">DrawWidth</see>.
|
||||
/// </summary>
|
||||
public float Resolution
|
||||
{
|
||||
|
||||
@@ -43,7 +43,7 @@ namespace osu.Framework.Graphics.Containers
|
||||
private MaskingInfo? maskingInfo;
|
||||
|
||||
/// <summary>
|
||||
/// The screen-space version of <see cref="OpenGL.MaskingInfo.MaskingRect"/>.
|
||||
/// The screen-space version of <see cref="MaskingInfo.MaskingRect"/>.
|
||||
/// Used as cache of screen-space masking quads computed in previous frames.
|
||||
/// Assign null to reset.
|
||||
/// </summary>
|
||||
|
||||
@@ -428,7 +428,7 @@ namespace osu.Framework.Graphics.Containers
|
||||
{
|
||||
/// <summary>
|
||||
/// Any remaining area of the <see cref="GridContainer"/> will be divided amongst this and all
|
||||
/// other elements which use <see cref="GridSizeMode.Distributed"/>.
|
||||
/// other elements which use <see cref="Distributed"/>.
|
||||
/// </summary>
|
||||
Distributed,
|
||||
|
||||
|
||||
@@ -222,7 +222,7 @@ namespace osu.Framework.Graphics.Containers
|
||||
where TSpriteText : SpriteText, new()
|
||||
=> AddPart(CreateChunkFor(text, true, () => new TSpriteText(), creationParameters));
|
||||
|
||||
/// <inheritdoc cref="AddText{TSpriteText}(LocalisableString,System.Action{TSpriteText})"/>
|
||||
/// <inheritdoc cref="AddText{TSpriteText}(LocalisableString,Action{TSpriteText})"/>
|
||||
public ITextPart AddText(LocalisableString text, Action<SpriteText> creationParameters = null)
|
||||
=> AddPart(CreateChunkFor(text, true, CreateSpriteText, creationParameters));
|
||||
|
||||
|
||||
@@ -74,10 +74,10 @@ namespace osu.Framework.Graphics.Containers
|
||||
protected abstract void PopOut();
|
||||
|
||||
/// <summary>
|
||||
/// Called whenever <see cref="VisibilityContainer.State"/> is changed.
|
||||
/// Called whenever <see cref="State"/> is changed.
|
||||
/// Used to update this container's elements according to the new visibility state.
|
||||
/// </summary>
|
||||
/// <param name="state">The <see cref="ValueChangedEvent{T}"/> provided by <see cref="VisibilityContainer.State"/></param>
|
||||
/// <param name="state">The <see cref="ValueChangedEvent{T}"/> provided by <see cref="State"/></param>
|
||||
protected virtual void UpdateState(ValueChangedEvent<Visibility> state)
|
||||
{
|
||||
switch (state.NewValue)
|
||||
|
||||
@@ -1082,7 +1082,7 @@ namespace osu.Framework.Graphics
|
||||
/// <summary>
|
||||
/// The origin of this <see cref="Drawable"/>.
|
||||
/// </summary>
|
||||
/// <exception cref="ArgumentException">If the provided value does not exist in the <see cref="osu.Framework.Graphics.Anchor"/> enumeration.</exception>
|
||||
/// <exception cref="ArgumentException">If the provided value does not exist in the <see cref="Graphics.Anchor"/> enumeration.</exception>
|
||||
public virtual Anchor Origin
|
||||
{
|
||||
get => origin;
|
||||
@@ -1103,7 +1103,7 @@ namespace osu.Framework.Graphics
|
||||
/// <summary>
|
||||
/// The origin of this <see cref="Drawable"/> expressed in relative coordinates from the top-left corner of <see cref="DrawRectangle"/>.
|
||||
/// </summary>
|
||||
/// <exception cref="InvalidOperationException">If <see cref="Origin"/> is <see cref="osu.Framework.Graphics.Anchor.Custom"/>.</exception>
|
||||
/// <exception cref="InvalidOperationException">If <see cref="Origin"/> is <see cref="Anchor.Custom"/>.</exception>
|
||||
public Vector2 RelativeOriginPosition
|
||||
{
|
||||
get
|
||||
@@ -2343,7 +2343,7 @@ namespace osu.Framework.Graphics
|
||||
public virtual bool HandlePositionalInput => RequestsPositionalInput;
|
||||
|
||||
/// <summary>
|
||||
/// Nested class which is used for caching <see cref="Drawable.HandleNonPositionalInput"/>, <see cref="Drawable.HandlePositionalInput"/> values obtained via reflection.
|
||||
/// Nested class which is used for caching <see cref="HandleNonPositionalInput"/>, <see cref="HandlePositionalInput"/> values obtained via reflection.
|
||||
/// </summary>
|
||||
private static class HandleInputCache
|
||||
{
|
||||
@@ -2742,7 +2742,7 @@ namespace osu.Framework.Graphics
|
||||
Colour = 1 << 3,
|
||||
|
||||
/// <summary>
|
||||
/// <see cref="Graphics.DrawNode.ApplyState"/> has to be invoked on all old draw nodes.
|
||||
/// <see cref="DrawNode.ApplyState"/> has to be invoked on all old draw nodes.
|
||||
/// This <see cref="Invalidation"/> flag never propagates to children.
|
||||
/// </summary>
|
||||
DrawNode = 1 << 4,
|
||||
|
||||
@@ -50,7 +50,7 @@ namespace osu.Framework.Graphics.Primitives
|
||||
}
|
||||
|
||||
/// <summary>Gets or sets the coordinates of the upper-left corner of this <see cref="RectangleF"/> structure.</summary>
|
||||
/// <returns>A <see cref="osuTK.Vector2"/> that represents the upper-left corner of this <see cref="RectangleF"/> structure.</returns>
|
||||
/// <returns>A <see cref="Vector2"/> that represents the upper-left corner of this <see cref="RectangleF"/> structure.</returns>
|
||||
/// <filterpriority>1</filterpriority>
|
||||
[Browsable(false)]
|
||||
public Vector2 Location
|
||||
@@ -64,7 +64,7 @@ namespace osu.Framework.Graphics.Primitives
|
||||
}
|
||||
|
||||
/// <summary>Gets or sets the size of this <see cref="RectangleF"/>.</summary>
|
||||
/// <returns>A <see cref="osuTK.Vector2"/> that represents the width and height of this <see cref="RectangleF"/> structure.</returns>
|
||||
/// <returns>A <see cref="Vector2"/> that represents the width and height of this <see cref="RectangleF"/> structure.</returns>
|
||||
/// <filterpriority>1</filterpriority>
|
||||
[Browsable(false)]
|
||||
public Vector2 Size
|
||||
|
||||
@@ -39,13 +39,13 @@ namespace osu.Framework.Graphics.Primitives
|
||||
}
|
||||
|
||||
/// <summary>Gets or sets the coordinates of the upper-left corner of this <see cref="RectangleI"/> structure.</summary>
|
||||
/// <returns>A <see cref="osuTK.Vector2"/> that represents the upper-left corner of this <see cref="RectangleI"/> structure.</returns>
|
||||
/// <returns>A <see cref="Vector2"/> that represents the upper-left corner of this <see cref="RectangleI"/> structure.</returns>
|
||||
/// <filterpriority>1</filterpriority>
|
||||
[Browsable(false)]
|
||||
public Vector2I Location => new Vector2I(X, Y);
|
||||
|
||||
/// <summary>Gets or sets the size of this <see cref="RectangleI"/>.</summary>
|
||||
/// <returns>A <see cref="osuTK.Vector2"/> that represents the width and height of this <see cref="RectangleI"/> structure.</returns>
|
||||
/// <returns>A <see cref="Vector2"/> that represents the width and height of this <see cref="RectangleI"/> structure.</returns>
|
||||
/// <filterpriority>1</filterpriority>
|
||||
[Browsable(false)]
|
||||
public Vector2I Size => new Vector2I(Width, Height);
|
||||
|
||||
@@ -8,7 +8,7 @@ namespace osu.Framework.Layout
|
||||
{
|
||||
/// <summary>
|
||||
/// A member that represents the validation state of the layout of a <see cref="Drawable"/>.
|
||||
/// Can be invalidated according to state changes in a <see cref="Drawable"/> (via <see cref="Graphics.Invalidation"/> flags), and validated on-demand when the layout has been re-computed.
|
||||
/// Can be invalidated according to state changes in a <see cref="Drawable"/> (via <see cref="Invalidation"/> flags), and validated on-demand when the layout has been re-computed.
|
||||
/// </summary>
|
||||
public class LayoutValue : LayoutMember
|
||||
{
|
||||
@@ -31,7 +31,7 @@ namespace osu.Framework.Layout
|
||||
|
||||
/// <summary>
|
||||
/// A member that represents the validation state of a value in the layout of a <see cref="Drawable"/>.
|
||||
/// Can be invalidated according to state changes in a <see cref="Drawable"/> (via <see cref="Graphics.Invalidation"/> flags), and validated when an up-to-date value is set.
|
||||
/// Can be invalidated according to state changes in a <see cref="Drawable"/> (via <see cref="Invalidation"/> flags), and validated when an up-to-date value is set.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of value stored.</typeparam>
|
||||
public class LayoutValue<T> : LayoutMember
|
||||
|
||||
@@ -63,11 +63,11 @@ namespace osu.Framework.Platform
|
||||
/// <summary>
|
||||
/// Controls the state of the OS cursor.
|
||||
/// </summary>
|
||||
/// <remarks>If the cursor is <see cref="Platform.CursorState.Confined"/>, <see cref="CursorConfineRect"/> will be used.</remarks>
|
||||
/// <remarks>If the cursor is <see cref="CursorState.Confined"/>, <see cref="CursorConfineRect"/> will be used.</remarks>
|
||||
CursorState CursorState { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Area to which the mouse cursor is confined to when <see cref="CursorState"/> is <see cref="Platform.CursorState.Confined"/>.
|
||||
/// Area to which the mouse cursor is confined to when <see cref="CursorState"/> is <see cref="CursorState.Confined"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Will confine to the whole window by default (or when set to <c>null</c>).
|
||||
|
||||
@@ -166,7 +166,7 @@ namespace osu.Framework.Platform
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="OsuTKWindow"/> with given dimensions.
|
||||
/// <para>Note that this will use the default <see cref="osuTK.GameWindow"/> implementation, which is not compatible with every platform.</para>
|
||||
/// <para>Note that this will use the default <see cref="GameWindow"/> implementation, which is not compatible with every platform.</para>
|
||||
/// </summary>
|
||||
protected OsuTKWindow(int width, int height)
|
||||
: this(new GameWindow(width, height, new GraphicsMode(GraphicsMode.Default.ColorFormat, GraphicsMode.Default.Depth, GraphicsMode.Default.Stencil, GraphicsMode.Default.Samples, GraphicsMode.Default.AccumulatorFormat, 3)))
|
||||
|
||||
@@ -83,7 +83,7 @@ namespace osu.Framework.Platform
|
||||
private Point position;
|
||||
|
||||
/// <summary>
|
||||
/// Returns or sets the window's position in screen space. Only valid when in <see cref="osu.Framework.Configuration.WindowMode.Windowed"/>
|
||||
/// Returns or sets the window's position in screen space. Only valid when in <see cref="WindowMode.Windowed"/>
|
||||
/// </summary>
|
||||
public Point Position
|
||||
{
|
||||
@@ -98,7 +98,7 @@ namespace osu.Framework.Platform
|
||||
private bool resizable = true;
|
||||
|
||||
/// <summary>
|
||||
/// Returns or sets whether the window is resizable or not. Only valid when in <see cref="osu.Framework.Platform.WindowState.Normal"/>.
|
||||
/// Returns or sets whether the window is resizable or not. Only valid when in <see cref="WindowState.Normal"/>.
|
||||
/// </summary>
|
||||
public bool Resizable
|
||||
{
|
||||
|
||||
@@ -54,7 +54,7 @@ namespace osu.Framework.Statistics
|
||||
PositionalIQ,
|
||||
|
||||
/// <summary>
|
||||
/// See <see cref="osu.Framework.Graphics.Containers.CompositeDrawable.CheckChildrenLife"/>.
|
||||
/// See <see cref="Graphics.Containers.CompositeDrawable.CheckChildrenLife"/>.
|
||||
/// </summary>
|
||||
CCL,
|
||||
|
||||
|
||||
Reference in New Issue
Block a user