Browse Source

Update XML Comment

Giuseppe Lippolis 5 years ago
parent
commit
a6c705bf70

+ 1 - 0
src/Avalonia.Controls.DataGrid/DataGridColumn.cs

@@ -665,6 +665,7 @@ namespace Avalonia.Controls
         /// <param name="dataItem">
         /// The data item represented by the row that contains the intended cell.
         /// </param>
+        /// <param name="binding">When the method returns, contains the applied binding.</param>
         /// <returns>
         /// A new editing element that is bound to the column's <see cref="P:Avalonia.Controls.DataGridBoundColumn.Binding" /> property value.
         /// </returns>

+ 1 - 0
src/Avalonia.Controls/Primitives/IPopupHost.cs

@@ -47,6 +47,7 @@ namespace Avalonia.Controls.Primitives
         /// <param name="offset">The offset, in device-independent pixels.</param>
         /// <param name="anchor">The anchor point.</param>
         /// <param name="gravity">The popup gravity.</param>
+        /// <param name="constraintAdjustment">Defines how a popup position will be adjusted if the unadjusted position would result in the popup being partly constrained.</param>
         /// <param name="rect">
         /// The anchor rect. If null, the bounds of <paramref name="target"/> will be used.
         /// </param>

+ 1 - 1
src/Avalonia.Controls/Window.cs

@@ -451,7 +451,7 @@ namespace Avalonia.Controls
         /// </summary>
         /// <param name="dialogResult">The dialog result.</param>
         /// <remarks>
-        /// When the window is shown with the <see cref="ShowDialog{TResult}(IWindowImpl)"/>
+        /// When the window is shown with the <see cref="ShowDialog{TResult}(Window)"/>
         /// or <see cref="ShowDialog{TResult}(Window)"/> method, the
         /// resulting task will produce the <see cref="_dialogResult"/> value when the window
         /// is closed.

+ 0 - 1
src/Avalonia.Visuals/Media/Imaging/Bitmap.cs

@@ -99,7 +99,6 @@ namespace Avalonia.Media.Imaging
         /// Initializes a new instance of the <see cref="Bitmap"/> class.
         /// </summary>
         /// <param name="format">The pixel format.</param>
-        /// <param name="alphaFormat">The alpha format.</param>
         /// <param name="data">The pointer to the source bytes.</param>
         /// <param name="size">The size of the bitmap in device pixels.</param>
         /// <param name="dpi">The DPI of the bitmap.</param>

+ 1 - 1
src/Avalonia.Visuals/Platform/IDrawingContextImpl.cs

@@ -63,7 +63,7 @@ namespace Avalonia.Platform
         /// <param name="brush">The brush used to fill the rectangle, or <c>null</c> for no fill.</param>
         /// <param name="pen">The pen used to stroke the rectangle, or <c>null</c> for no stroke.</param>
         /// <param name="rect">The rectangle bounds.</param>
-        /// <param name="boxShadows">Box shadow effect parameters</param>
+        /// <param name="boxShadow">Box shadow effect parameters</param>
         /// <remarks>
         /// The brush and the pen can both be null. If the brush is null, then no fill is performed.
         /// If the pen is null, then no stoke is performed. If both the pen and the brush are null, then the drawing is not visible.

+ 3 - 4
src/Avalonia.Visuals/Rendering/SceneGraph/ExperimentalAcrylicNode.cs

@@ -13,10 +13,9 @@ namespace Avalonia.Rendering.SceneGraph
         /// <summary>
         /// Initializes a new instance of the <see cref="RectangleNode"/> class.
         /// </summary>
-        /// <param name="transform">The transform.</param>        
+        /// <param name="transform">The transform.</param>
+        /// <param name="material"></param>        
         /// <param name="rect">The rectangle to draw.</param>
-        /// <param name="boxShadow">The box shadow parameters</param>
-        /// <param name="childScenes">Child scenes for drawing visual brushes.</param>
         public ExperimentalAcrylicNode(
             Matrix transform,
             IExperimentalAcrylicMaterial material,
@@ -44,7 +43,7 @@ namespace Avalonia.Rendering.SceneGraph
         /// Determines if this draw operation equals another.
         /// </summary>
         /// <param name="transform">The transform of the other draw operation.</param>
-        /// <param name="brush">The fill of the other draw operation.</param>
+        /// <param name="material">The fill of the other draw operation.</param>
         /// <param name="rect">The rectangle of the other draw operation.</param>        
         /// <returns>True if the draw operations are the same, otherwise false.</returns>
         /// <remarks>

+ 0 - 1
src/Avalonia.Visuals/Rendering/SceneGraph/GeometryNode.cs

@@ -63,7 +63,6 @@ namespace Avalonia.Rendering.SceneGraph
         /// <param name="brush">The fill of the other draw operation.</param>
         /// <param name="pen">The stroke of the other draw operation.</param>
         /// <param name="geometry">The geometry of the other draw operation.</param>
-        /// <param name="boxShadow">The box shadow parameters</param>
         /// <returns>True if the draw operations are the same, otherwise false.</returns>
         /// <remarks>
         /// The properties of the other draw operation are passed in as arguments to prevent

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

@@ -73,7 +73,7 @@ namespace Avalonia.Rendering.SceneGraph
         /// <param name="brush">The fill of the other draw operation.</param>
         /// <param name="pen">The stroke of the other draw operation.</param>
         /// <param name="rect">The rectangle of the other draw operation.</param>
-        /// <param name="boxShadow">The box shadow parameters of the other draw operation</param>
+        /// <param name="boxShadows">The box shadow parameters of the other draw operation</param>
         /// <returns>True if the draw operations are the same, otherwise false.</returns>
         /// <remarks>
         /// The properties of the other draw operation are passed in as arguments to prevent

+ 8 - 8
src/Linux/Avalonia.LinuxFramebuffer/Output/Drm.cs

@@ -113,22 +113,22 @@ namespace Avalonia.LinuxFramebuffer.Output
         [StructLayout(LayoutKind.Sequential)]
         public struct drmModeConnector {
             public uint connector_id;
-            public uint encoder_id; /**< Encoder currently connected to */
+            public uint encoder_id; // Encoder currently connected to 
             public uint connector_type;
             public uint connector_type_id;
             public DrmModeConnection connection;
-            public uint mmWidth, mmHeight; /**< HxW in millimeters */
+            public uint mmWidth, mmHeight; //  HxW in millimeters 
             public DrmModeSubPixel subpixel;
 
             public int count_modes;
             public drmModeModeInfo* modes;
 
             public int count_props;
-            public uint *props; /**< List of property ids */
-            public ulong *prop_values; /**< List of property values */
+            public uint *props; // List of property ids 
+            public ulong *prop_values; // List of property values 
 
             public int count_encoders;
-            public uint *encoders; /**< List of encoder ids */
+            public uint *encoders; //List of encoder ids
         }
         
         [StructLayout(LayoutKind.Sequential)]
@@ -143,14 +143,14 @@ namespace Avalonia.LinuxFramebuffer.Output
         [StructLayout(LayoutKind.Sequential)]
         public struct drmModeCrtc {
             public uint crtc_id;
-            public uint buffer_id; /**< FB id to connect to 0 = disconnect */
+            public uint buffer_id; // FB id to connect to 0 = disconnect 
 
-            public uint x, y; /**< Position on the framebuffer */
+            public uint x, y; // Position on the framebuffer 
             public uint width, height;
             public int mode_valid;
             public drmModeModeInfo mode;
 
-            public int gamma_size; /**< Number of gamma stops */
+            public int gamma_size; // Number of gamma stops 
 
         }
         

+ 26 - 5
src/Markup/Avalonia.Markup.Xaml.Loader/AvaloniaRuntimeXamlLoader.cs

@@ -3,7 +3,6 @@ using System.IO;
 using System.Reflection;
 using System.Text;
 using Avalonia.Markup.Xaml.XamlIl;
-// ReSharper disable CheckNamespace
 
 namespace Avalonia.Markup.Xaml
 {
@@ -13,10 +12,10 @@ namespace Avalonia.Markup.Xaml
         /// Loads XAML from a string.
         /// </summary>
         /// <param name="xaml">The string containing the XAML.</param>
-        /// <param name="localAssembly">Default assembly for clr-namespace:</param>
-        /// <param name="rootInstance">
-        /// The optional instance into which the XAML should be loaded.
-        /// </param>
+        /// <param name="localAssembly">Default assembly for clr-namespace:.</param>
+        /// <param name="rootInstance">The optional instance into which the XAML should be loaded.</param>
+        /// <param name="uri">The URI of the XAML being loaded.</param>
+        /// <param name="designMode">Indicates whether the XAML is being loaded in design mode.</param>
         /// <returns>The loaded object.</returns>
         public static object Load(string xaml, Assembly localAssembly = null, object rootInstance = null, Uri uri = null, bool designMode = false)
         {
@@ -28,13 +27,35 @@ namespace Avalonia.Markup.Xaml
             }
         }
 
+        /// <summary>
+        /// Loads XAML from a stream.
+        /// </summary>
+        /// <param name="stream">The stream containing the XAML.</param>
+        /// <param name="localAssembly">Default assembly for clr-namespace:</param>
+        /// <param name="rootInstance">The optional instance into which the XAML should be loaded.</param>
+        /// <param name="uri">The URI of the XAML being loaded.</param>
+        /// <param name="designMode">Indicates whether the XAML is being loaded in design mode.</param>
+        /// <returns>The loaded object.</returns>
         public static object Load(Stream stream, Assembly localAssembly, object rootInstance = null, Uri uri = null,
             bool designMode = false)
             => AvaloniaXamlIlRuntimeCompiler.Load(stream, localAssembly, rootInstance, uri, designMode);
 
+        /// <summary>
+        /// Parse XAML from a string.
+        /// </summary>
+        /// <param name="xaml">The string containing the XAML.</param>
+        /// <param name="localAssembly">Default assembly for clr-namespace:.</param>
+        /// <returns>The loaded object.</returns>
         public static object Parse(string xaml, Assembly localAssembly = null)
             => Load(xaml, localAssembly);
 
+        /// <summary>
+        /// Parse XAML from a string.
+        /// </summary>
+        /// <typeparam name="T">The type of the returned object.</typeparam>
+        /// <param name="xaml">>The string containing the XAML.</param>
+        /// <param name="localAssembly">>Default assembly for clr-namespace:.</param>
+        /// <returns>The loaded object.</returns>
         public static T Parse<T>(string xaml, Assembly localAssembly = null)
             => (T)Parse(xaml, localAssembly);
             

+ 0 - 1
src/Windows/Avalonia.Direct2D1/Media/DrawingContextImpl.cs

@@ -323,7 +323,6 @@ namespace Avalonia.Direct2D1.Media
         /// </summary>
         /// <param name="foreground">The foreground.</param>
         /// <param name="glyphRun">The glyph run.</param>
-        /// <param name="baselineOrigin"></param>
         public void DrawGlyphRun(IBrush foreground, GlyphRun glyphRun)
         {
             using (var brush = CreateBrush(foreground, glyphRun.Size))

+ 1 - 0
src/Windows/Avalonia.Win32/Interop/TaskBarList.cs

@@ -13,6 +13,7 @@ namespace Avalonia.Win32.Interop
         /// <summary>
         /// Ported from https://github.com/chromium/chromium/blob/master/ui/views/win/fullscreen_handler.cc
         /// </summary>
+        /// <param name="hwnd">The window handle.</param>
         /// <param name="fullscreen">Fullscreen state.</param>
         public static unsafe void MarkFullscreen(IntPtr hwnd, bool fullscreen)
         {