Browse Source

add comments to new properties.

Dan Walmsley 7 years ago
parent
commit
89767c8b78
1 changed files with 8 additions and 1 deletions
  1. 8 1
      src/Avalonia.Controls/Primitives/Popup.cs

+ 8 - 1
src/Avalonia.Controls/Primitives/Popup.cs

@@ -39,7 +39,10 @@ namespace Avalonia.Controls.Primitives
         /// </summary>
         public static readonly StyledProperty<PlacementMode> PlacementModeProperty =
             AvaloniaProperty.Register<Popup, PlacementMode>(nameof(PlacementMode), defaultValue: PlacementMode.Bottom);
-
+        
+        /// <summary>
+        /// Degines the <see cref="ObeyScreenEdges"/> property.
+        /// </summary>
         public static readonly StyledProperty<bool> ObeyScreenEdgesProperty =
             AvaloniaProperty.Register<Popup, bool>(nameof(ObeyScreenEdges));
 
@@ -139,6 +142,10 @@ namespace Avalonia.Controls.Primitives
             set { SetValue(PlacementModeProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the popup positions itself within the nearest screen boundary
+        /// when its opened at a position where it would otherwise overlap the screen edge.
+        /// </summary>
         public bool ObeyScreenEdges
         {
             get => GetValue(ObeyScreenEdgesProperty);