Browse Source

ClearFrame API docs

Tig 1 year ago
parent
commit
dff0be099e
1 changed files with 3 additions and 2 deletions
  1. 3 2
      Terminal.Gui/View/ViewDrawing.cs

+ 3 - 2
Terminal.Gui/View/ViewDrawing.cs

@@ -102,9 +102,10 @@ public partial class View
         Driver.SetAttribute (prev);
         Driver.SetAttribute (prev);
     }
     }
 
 
-    /// <summary>Clears the <see cref="Frame"/> with the normal background color.</summary>
+    /// <summary>Clears the entire view (<see cref="Frame"/>) with the normal background color.</summary>
     /// <remarks>
     /// <remarks>
-    ///     <para>This clears the Bounds used by this view.</para>
+    ///     <para>This method will clear the area occupied by the <see cref="Margin"/>, <see cref="Border"/>, and <see cref="Padding"/>, as
+    ///     well as the <see cref="Bounds"/>. Use <see cref="Clear()"/> to clear just the <see cref="Bounds"/>.</para>
     /// </remarks>
     /// </remarks>
     public void ClearFrame ()
     public void ClearFrame ()
     {
     {