Browse Source

Update xmldoc

tznind 10 months ago
parent
commit
a8e3a0ec2b
1 changed files with 8 additions and 1 deletions
  1. 8 1
      Terminal.Gui/Drawing/SixelSupportDetector.cs

+ 8 - 1
Terminal.Gui/Drawing/SixelSupportDetector.cs

@@ -4,11 +4,18 @@ using Microsoft.CodeAnalysis;
 namespace Terminal.Gui;
 namespace Terminal.Gui;
 
 
 /// <summary>
 /// <summary>
-///     Uses ANSII escape sequences to detect whether sixel is supported
+///     Uses Ansi escape sequences to detect whether sixel is supported
 ///     by the terminal.
 ///     by the terminal.
 /// </summary>
 /// </summary>
 public class SixelSupportDetector
 public class SixelSupportDetector
 {
 {
+    /// <summary>
+    /// Sends Ansi escape sequences to the console to determine whether
+    /// sixel is supported (and <see cref="SixelSupportResult.Resolution"/>
+    /// etc).
+    /// </summary>
+    /// <returns>Description of sixel support, may include assumptions where
+    /// expected response codes are not returned by console.</returns>
     public SixelSupportResult Detect ()
     public SixelSupportResult Detect ()
     {
     {
         var result = new SixelSupportResult ();
         var result = new SixelSupportResult ();