Skip to content

Commit

Permalink
Merge pull request #10582 from workgroupengineering/fixes/Warnings/XM…
Browse files Browse the repository at this point in the history
…L_Comment

fix: Misc XML Document issue
  • Loading branch information
maxkatz6 authored Mar 8, 2023
2 parents 3c74c7c + 02983e3 commit e9cd5d5
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 12 deletions.
13 changes: 12 additions & 1 deletion src/Avalonia.Base/AvaloniaProperty.cs
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,18 @@ public static StyledProperty<TValue> Register<TOwner, TValue>(
return result;
}

/// <inheritdoc cref="Register{TOwner, TValue}" />
/// <summary>
/// Registers an attached <see cref="AvaloniaProperty"/>.
/// </summary>
/// <typeparam name="TOwner">The type of the class that is registering the property.</typeparam>
/// <typeparam name="TValue">The type of the property's value.</typeparam>
/// <param name="name">The name of the property.</param>
/// <param name="defaultValue">The default value of the property.</param>
/// <param name="inherits">Whether the property inherits its value.</param>
/// <param name="defaultBindingMode">The default binding mode for the property.</param>
/// <param name="validate">A value validation callback.</param>
/// <param name="coerce">A value coercion callback.</param>
/// <param name="enableDataValidation">if is set to true enable data validation.</param>
/// <param name="notifying">
/// A method that gets called before and after the property starts being notified on an
/// object; the bool argument will be true before and false afterwards. This callback is
Expand Down
2 changes: 1 addition & 1 deletion src/Avalonia.Base/AvaloniaPropertyRegistry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ public bool IsRegistered(object o, AvaloniaProperty property)
/// <param name="property">The property.</param>
/// <remarks>
/// You won't usually want to call this method directly, instead use the
/// <see cref="AvaloniaProperty.Register{TOwner, TValue}(string, TValue, bool, Data.BindingMode, Func{TValue, bool}, Func{AvaloniaObject, TValue, TValue}, Action{AvaloniaObject, bool})"/>
/// <see cref="AvaloniaProperty.Register{TOwner, TValue}(string, TValue, bool, Data.BindingMode, Func{TValue, bool}, Func{AvaloniaObject, TValue, TValue}, bool)"/>
/// method.
/// </remarks>
public void Register(Type type, AvaloniaProperty property)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ public static TextLineImpl CreateEmptyTextLine(int firstTextSourceIndex, double
/// Performs text wrapping returns a list of text lines.
/// </summary>
/// <param name="textRuns"></param>
/// <param name="canReuseTextRunList">Whether <see cref="textRuns"/> can be reused to store the split runs.</param>
/// <param name="canReuseTextRunList">Whether <see cref="TextRun"/> can be reused to store the split runs.</param>
/// <param name="firstTextSourceIndex">The first text source index.</param>
/// <param name="paragraphWidth">The paragraph width.</param>
/// <param name="paragraphProperties">The text paragraph properties.</param>
Expand Down
1 change: 1 addition & 0 deletions src/Avalonia.Base/Platform/IDrawingContextImpl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ void DrawRectangle(IBrush? brush, IPen? pen, RoundedRect rect,
/// Pushes an opacity value.
/// </summary>
/// <param name="opacity">The opacity.</param>
/// <param name="bounds">where to apply the opacity.</param>
void PushOpacity(double opacity, Rect bounds);

/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion src/Avalonia.Base/Rendering/DisplayDirtyRect.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Avalonia.Rendering
{
/// <summary>
/// Holds the state for a dirty rect rendered when <see cref="IRenderer.DrawDirtyRects"/> is set.
/// Holds the state for a dirty rect rendered when <see cref="IRenderer.SceneInvalidated"/> is set.
/// </summary>
internal class DisplayDirtyRect
{
Expand Down
1 change: 0 additions & 1 deletion src/Avalonia.Base/Rendering/SceneGraph/GeometryNode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ internal class GeometryNode : BrushDrawOperation
/// <param name="brush">The fill brush.</param>
/// <param name="pen">The stroke pen.</param>
/// <param name="geometry">The geometry.</param>
/// <param name="aux">Auxiliary data required to draw the brush.</param>
public GeometryNode(Matrix transform,
IImmutableBrush? brush,
IPen? pen,
Expand Down
1 change: 0 additions & 1 deletion src/Avalonia.Base/Rendering/SceneGraph/LineNode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ internal class LineNode : DrawOperationWithTransform
/// <param name="pen">The stroke pen.</param>
/// <param name="p1">The start point of the line.</param>
/// <param name="p2">The end point of the line.</param>
/// <param name="aux">Auxiliary data required to draw the brush.</param>
public LineNode(
Matrix transform,
IPen pen,
Expand Down
1 change: 0 additions & 1 deletion src/Avalonia.Base/Rendering/SceneGraph/OpacityMaskNode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ internal class OpacityMaskNode : BrushDrawOperation
/// </summary>
/// <param name="mask">The opacity mask to push.</param>
/// <param name="bounds">The bounds of the mask.</param>
/// <param name="aux">Auxiliary data required to draw the brush.</param>
public OpacityMaskNode(IImmutableBrush mask, Rect bounds)
: base(default, Matrix.Identity, mask)
{
Expand Down
1 change: 0 additions & 1 deletion src/Avalonia.Base/Rendering/SceneGraph/RectangleNode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ internal class RectangleNode : BrushDrawOperation
/// <param name="pen">The stroke pen.</param>
/// <param name="rect">The rectangle to draw.</param>
/// <param name="boxShadows">The box shadow parameters</param>
/// <param name="aux">Auxiliary data required to draw the brush.</param>
public RectangleNode(
Matrix transform,
IImmutableBrush? brush,
Expand Down
2 changes: 1 addition & 1 deletion src/Avalonia.Controls/Platform/IInsetsManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public SafeAreaChangedArgs(Thickness safeArePadding)
SafeAreaPadding = safeArePadding;
}

/// <inheritdoc cref="IInsetsManager.GetSafeAreaPadding"/>
/// <inheritdoc cref="IInsetsManager.SafeAreaPadding"/>
public Thickness SafeAreaPadding { get; }
}

Expand Down
2 changes: 1 addition & 1 deletion src/Avalonia.Controls/SplitButton/SplitButton.cs
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ private void SecondaryButton_Click(object? sender, RoutedEventArgs e)
}

/// <summary>
/// Called when the <see cref="FlyoutBase.Placement"/> property changes.
/// Called when the <see cref="PopupFlyoutBase.Placement"/> property changes.
/// </summary>
private void Flyout_PlacementPropertyChanged(AvaloniaPropertyChangedEventArgs e)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Browser/Avalonia.Browser/BrowserAppBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public class BrowserPlatformOptions
public static class BrowserAppBuilder
{
/// <summary>
/// Configures browser backend, loads avalonia javascript modules and creates a single view lifetime from the passed <see cref="mainDivId"/> parameter.
/// Configures browser backend, loads avalonia javascript modules and creates a single view lifetime from the passed <see paramref="mainDivId"/> parameter.
/// </summary>
/// <param name="builder">Application builder.</param>
/// <param name="mainDivId">ID of the html element where avalonia content should be rendered.</param>
Expand Down
1 change: 0 additions & 1 deletion src/Windows/Avalonia.Direct2D1/Media/DrawingContextImpl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ internal class DrawingContextImpl : IDrawingContextImpl
/// <summary>
/// Initializes a new instance of the <see cref="DrawingContextImpl"/> class.
/// </summary>
/// <param name="visualBrushRenderer">The visual brush renderer.</param>
/// <param name="renderTarget">The render target to draw to.</param>
/// <param name="layerFactory">
/// An object to use to create layers. May be null, in which case a
Expand Down

0 comments on commit e9cd5d5

Please sign in to comment.