Browse Source
Merge pull request #10582 from workgroupengineering/fixes/Warnings/XML_Comment
fix: Misc XML Document issue
pull/10601/head
Max Katz
4 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with
19 additions and
12 deletions
src/Avalonia.Base/AvaloniaProperty.cs
src/Avalonia.Base/AvaloniaPropertyRegistry.cs
src/Avalonia.Base/Media/TextFormatting/TextFormatterImpl.cs
src/Avalonia.Base/Platform/IDrawingContextImpl.cs
src/Avalonia.Base/Rendering/DisplayDirtyRect.cs
src/Avalonia.Base/Rendering/SceneGraph/GeometryNode.cs
src/Avalonia.Base/Rendering/SceneGraph/LineNode.cs
src/Avalonia.Base/Rendering/SceneGraph/OpacityMaskNode.cs
src/Avalonia.Base/Rendering/SceneGraph/RectangleNode.cs
src/Avalonia.Controls/Platform/IInsetsManager.cs
src/Avalonia.Controls/SplitButton/SplitButton.cs
src/Browser/Avalonia.Browser/BrowserAppBuilder.cs
src/Windows/Avalonia.Direct2D1/Media/DrawingContextImpl.cs
@ -257,7 +257,18 @@ namespace Avalonia
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
@ -364,7 +364,7 @@ namespace Avalonia
/// <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 )
@ -658,7 +658,7 @@ namespace Avalonia.Media.TextFormatting
/// 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>
@ -128,6 +128,7 @@ namespace Avalonia.Platform
/// 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>
@ -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
{
@ -17,7 +17,6 @@ namespace Avalonia.Rendering.SceneGraph
/// <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 ,
@ -17,7 +17,6 @@ namespace Avalonia.Rendering.SceneGraph
/// <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 ,
@ -17,7 +17,6 @@ namespace Avalonia.Rendering.SceneGraph
/// </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 )
{
@ -20,7 +20,6 @@ namespace Avalonia.Rendering.SceneGraph
/// <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 ,
@ -36,7 +36,7 @@ namespace Avalonia.Controls.Platform
SafeAreaPadding = safeArePadding ;
}
/// <inheritdoc cref="IInsetsManager.Get SafeAreaPadding"/>
/// <inheritdoc cref="IInsetsManager.SafeAreaPadding"/>
public Thickness SafeAreaPadding { get ; }
}
@ -432,7 +432,7 @@ namespace Avalonia.Controls
}
/// <summary>
/// Called when the <see cref="FlyoutBase.Placement"/> property changes.
/// Called when the <see cref="Popup FlyoutBase.Placement"/> property changes.
/// </summary>
private void Flyout_PlacementPropertyChanged ( AvaloniaPropertyChangedEventArgs e )
{
@ -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 c ref="mainDivId"/> parameter.
/// Configures browser backend, loads avalonia javascript modules and creates a single view lifetime from the passed <see param ref="mainDivId"/> parameter.
/// </summary>
/// <param name="builder">Application builder.</param>
/// <param name="mainDivId">ID of the html element where avalonia content should be rendered.</param>
@ -29,7 +29,6 @@ namespace Avalonia.Direct2D1.Media
/// <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