Browse Source

Comment/warning clean up

Tigger Kindel 2 years ago
parent
commit
24c6b9b99d

+ 14 - 8
Terminal.Gui/Drawing/LineCanvas.cs

@@ -132,6 +132,8 @@ namespace Terminal.Gui {
 			}
 			}
 		}
 		}
 
 
+		// TODO: Unless there's an obvious use case for this API we should delete it in favor of the
+		// simpler version that doensn't take an area.
 		/// <summary>
 		/// <summary>
 		/// Evaluates the lines that have been added to the canvas and returns a map containing
 		/// Evaluates the lines that have been added to the canvas and returns a map containing
 		/// the glyphs and their locations. The glyphs are the characters that should be rendered
 		/// the glyphs and their locations. The glyphs are the characters that should be rendered
@@ -168,8 +170,7 @@ namespace Terminal.Gui {
 		/// the glyphs and their locations. The glyphs are the characters that should be rendered
 		/// the glyphs and their locations. The glyphs are the characters that should be rendered
 		/// so that all lines connect up with the appropriate intersection symbols. 
 		/// so that all lines connect up with the appropriate intersection symbols. 
 		/// </summary>
 		/// </summary>
-		/// <param name="inArea">A rectangle to constrain the search by.</param>
-		/// <returns>A map of the points within the canvas that intersect with <paramref name="inArea"/>.</returns>
+		/// <returns>A map of all the points within the canvas.</returns>
 		public Dictionary<Point, Cell> GetCellMap ()
 		public Dictionary<Point, Cell> GetCellMap ()
 		{
 		{
 			var map = new Dictionary<Point, Cell> ();
 			var map = new Dictionary<Point, Cell> ();
@@ -392,19 +393,24 @@ namespace Terminal.Gui {
 
 
 		}
 		}
 
 
+		/// <summary>
+		/// Represents a single row/column within the <see cref="LineCanvas"/>. Includes the glyph and the foreground/background colors.
+		/// </summary>
 		public class Cell
 		public class Cell
 		{
 		{
-			public Cell ()
-			{
-
-			}
-
+			/// <summary>
+			/// The glyph to draw.
+			/// </summary>
 			public Rune? Rune { get; set; }
 			public Rune? Rune { get; set; }
+
+			/// <summary>
+			/// The foreground color to draw the glyph with.
+			/// </summary>
 			public Attribute? Attribute { get; set; }
 			public Attribute? Attribute { get; set; }
 
 
 		}
 		}
 
 
-		private Cell? GetCellForIntersects (ConsoleDriver driver, IntersectionDefinition [] intersects)
+		private Cell GetCellForIntersects (ConsoleDriver driver, IntersectionDefinition [] intersects)
 		{
 		{
 			if (!intersects.Any ()) {
 			if (!intersects.Any ()) {
 				return null;
 				return null;

+ 2 - 0
Terminal.Gui/Views/Line.cs

@@ -22,6 +22,7 @@ namespace Terminal.Gui {
 
 
 		}
 		}
 		
 		
+		/// <inheritdoc/>
 		public override bool OnDrawFrames()
 		public override bool OnDrawFrames()
 		{
 		{
 			var screenBounds = ViewToScreen (Bounds);
 			var screenBounds = ViewToScreen (Bounds);
@@ -39,6 +40,7 @@ namespace Terminal.Gui {
 
 
 		//}
 		//}
 
 
+		/// <inheritdoc/>
 		public override void Redraw (Rect bounds)
 		public override void Redraw (Rect bounds)
 		{
 		{
 			OnDrawFrames ();
 			OnDrawFrames ();

+ 0 - 1
Terminal.Gui/Views/TileView.cs

@@ -380,7 +380,6 @@ namespace Terminal.Gui {
 		/// <summary>
 		/// <summary>
 		/// Overridden so no Frames get drawn (BUGBUG: v2 fix this hack)
 		/// Overridden so no Frames get drawn (BUGBUG: v2 fix this hack)
 		/// </summary>
 		/// </summary>
-		/// <param name="bounds"></param>
 		/// <returns></returns>
 		/// <returns></returns>
 		public override bool OnDrawFrames ()
 		public override bool OnDrawFrames ()
 		{
 		{

+ 1 - 2
Terminal.Gui/Views/Wizard/Wizard.cs

@@ -127,7 +127,6 @@ namespace Terminal.Gui {
 			/// <summary>
 			/// <summary>
 			/// Initializes a new instance of the <see cref="Wizard"/> class using <see cref="LayoutStyle.Computed"/> positioning.
 			/// Initializes a new instance of the <see cref="Wizard"/> class using <see cref="LayoutStyle.Computed"/> positioning.
 			/// </summary>
 			/// </summary>
-			/// </remarks>
 			public WizardStep ()
 			public WizardStep ()
 			{
 			{
 				BorderStyle = LineStyle.None;
 				BorderStyle = LineStyle.None;
@@ -700,7 +699,7 @@ namespace Terminal.Gui {
 		/// <summary>
 		/// <summary>
 		/// Determines whether the <see cref="Wizard"/> is displayed as modal pop-up or not.
 		/// Determines whether the <see cref="Wizard"/> is displayed as modal pop-up or not.
 		/// 
 		/// 
-		/// The default is <c>true</c>. The Wizard will be shown with a frame with <see cref="Title"/> and will behave like
+		/// The default is <see langword="true"/>. The Wizard will be shown with a frame and title and will behave like
 		/// any <see cref="Toplevel"/> window.
 		/// any <see cref="Toplevel"/> window.
 		/// 
 		/// 
 		/// If set to <c>false</c> the Wizard will have no frame and will behave like any embedded <see cref="View"/>.
 		/// If set to <c>false</c> the Wizard will have no frame and will behave like any embedded <see cref="View"/>.