Browse Source

fix: XML Comment

Giuseppe Lippolis 3 years ago
parent
commit
b38a50009e

+ 1 - 1
src/Avalonia.Base/Media/TextFormatting/Unicode/Codepoint.cs

@@ -224,7 +224,7 @@ namespace Avalonia.Media.TextFormatting.Unicode
         }
 
         /// <summary>
-        /// Returns <see langword="true"/> if <paramref name="value"/> is between
+        /// Returns <see langword="true"/> if <paramref name="cp"/> is between
         /// <paramref name="lowerBound"/> and <paramref name="upperBound"/>, inclusive.
         /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]

+ 2 - 2
src/Avalonia.Base/Rendering/Composition/Animations/CompositionAnimation.cs

@@ -16,10 +16,10 @@ namespace Avalonia.Rendering.Composition.Animations
     /// This is the base class for ExpressionAnimation and KeyFrameAnimation.
     /// </summary>
     /// <remarks>
-    /// Use the <see cref="CompositionObject.StartAnimation"/> method to start the animation.
+    /// Use the <see cref="CompositionObject.StartAnimation(string , CompositionAnimation)"/> method to start the animation.
     /// Value parameters (as opposed to reference parameters which are set using <see cref="SetReferenceParameter"/>)
     /// are copied and "embedded" into an expression at the time CompositionObject.StartAnimation is called.
-    /// Changing the value of the variable after <see cref="CompositionObject.StartAnimation"/> is called will not affect
+    /// Changing the value of the variable after <see cref="CompositionObject.StartAnimation(string , CompositionAnimation)"/> is called will not affect
     /// the value of the ExpressionAnimation.
     /// See the remarks section of ExpressionAnimation for additional information.
     /// </remarks>

+ 1 - 1
src/Avalonia.Base/Rendering/Composition/Animations/ExpressionAnimation.cs

@@ -16,7 +16,7 @@ namespace Avalonia.Rendering.Composition.Animations
     /// This contrasts <see cref="KeyFrameAnimation"/>s, which use an interpolator to define how the animating
     /// property changes over time. The mathematical equation can be defined using references to properties
     /// of Composition objects, mathematical functions and operators and Input.
-    /// Use the <see cref="CompositionObject.StartAnimation"/> method to start the animation.
+    /// Use the <see cref="CompositionObject.StartAnimation(string , CompositionAnimation)"/> method to start the animation.
     /// </remarks>
     public class ExpressionAnimation : CompositionAnimation
     {

+ 2 - 2
src/Avalonia.Base/Rendering/Composition/Animations/KeyFrameAnimation.cs

@@ -24,9 +24,9 @@ namespace Avalonia.Rendering.Composition.Animations
         /// The delay behavior of the key frame animation.
         /// </summary>
         public AnimationDelayBehavior DelayBehavior { get; set; }
-        
+
         /// <summary>
-        /// Delay before the animation starts after <see cref="CompositionObject.StartAnimation"/> is called.
+        /// Delay before the animation starts after <see cref="CompositionObject.StartAnimation(string , CompositionAnimation)"/> is called.
         /// </summary>
         public System.TimeSpan DelayTime { get; set; }
         

+ 1 - 1
src/Avalonia.Base/Rendering/SceneGraph/GeometryNode.cs

@@ -19,7 +19,7 @@ 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="childScenes">Child scenes for drawing visual brushes.</param>
+        /// <param name="aux">Auxiliary data required to draw the brush.</param>
         public GeometryNode(Matrix transform,
             IBrush? brush,
             IPen? pen,

+ 1 - 1
src/Avalonia.Base/Rendering/SceneGraph/GlyphRunNode.cs

@@ -19,7 +19,7 @@ namespace Avalonia.Rendering.SceneGraph
         /// <param name="transform">The transform.</param>
         /// <param name="foreground">The foreground brush.</param>
         /// <param name="glyphRun">The glyph run to draw.</param>
-        /// <param name="childScenes">Child scenes for drawing visual brushes.</param>
+        /// <param name="aux">Auxiliary data required to draw the brush.</param>
         public GlyphRunNode(
             Matrix transform,
             IBrush foreground,

+ 1 - 1
src/Avalonia.Base/Rendering/SceneGraph/LineNode.cs

@@ -19,7 +19,7 @@ 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="childScenes">Child scenes for drawing visual brushes.</param>
+        /// <param name="aux">Auxiliary data required to draw the brush.</param>
         public LineNode(
             Matrix transform,
             IPen pen,

+ 1 - 1
src/Avalonia.Base/Rendering/SceneGraph/OpacityMaskNode.cs

@@ -17,7 +17,7 @@ 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="childScenes">Child scenes for drawing visual brushes.</param>
+        /// <param name="aux">Auxiliary data required to draw the brush.</param>
         public OpacityMaskNode(IBrush mask, Rect bounds, IDisposable? aux = null)
             : base(Rect.Empty, Matrix.Identity, aux)
         {

+ 1 - 1
src/Avalonia.Base/Rendering/SceneGraph/RectangleNode.cs

@@ -20,7 +20,7 @@ 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="childScenes">Child scenes for drawing visual brushes.</param>
+        /// <param name="aux">Auxiliary data required to draw the brush.</param>
         public RectangleNode(
             Matrix transform,
             IBrush? brush,

+ 1 - 1
src/Avalonia.Base/Utilities/MathUtilities.cs

@@ -255,7 +255,7 @@ namespace Avalonia.Utilities
         /// <summary>
         /// Clamps a value between a minimum and maximum value.
         /// </summary>
-        /// <param name="val">The value.</param>
+        /// <param name="value">The value.</param>
         /// <param name="min">The minimum value.</param>
         /// <param name="max">The maximum value.</param>
         /// <returns>The clamped value.</returns>