소스 검색

Doc update

Miguel de Icaza 7 년 전
부모
커밋
ed31521f3d
3개의 변경된 파일13개의 추가작업 그리고 2개의 파일을 삭제
  1. 8 1
      Views/Button.cs
  2. 4 0
      Views/Checkbox.cs
  3. 1 1
      Views/Label.cs

+ 8 - 1
Views/Button.cs

@@ -11,12 +11,19 @@ using System.Linq;
 
 
 namespace Terminal {
 namespace Terminal {
 	/// <summary>
 	/// <summary>
-	///   Button view
+	///   Button is a view that provides an item that invokes a callback when activated.
 	/// </summary>
 	/// </summary>
 	/// <remarks>
 	/// <remarks>
+	/// <para>
 	///   Provides a button that can be clicked, or pressed with
 	///   Provides a button that can be clicked, or pressed with
 	///   the enter key and processes hotkeys (the first uppercase
 	///   the enter key and processes hotkeys (the first uppercase
 	///   letter in the button becomes the hotkey).
 	///   letter in the button becomes the hotkey).
+	/// </para>
+	/// <para>
+	///   If the button is configured as the default (IsDefault) the button
+	///   will respond to the return key is no other view processes it, and
+	///   turns this into a clicked event.
+	/// </para>
 	/// </remarks>
 	/// </remarks>
 	public class Button : View {
 	public class Button : View {
 		string text;
 		string text;

+ 4 - 0
Views/Checkbox.cs

@@ -7,6 +7,10 @@
 using System;
 using System;
 
 
 namespace Terminal {
 namespace Terminal {
+
+	/// <summary>
+	/// The Checkbox View shows an on/off toggle that the user can set
+	/// </summary>
 	public class CheckBox : View {
 	public class CheckBox : View {
 		string text;
 		string text;
 		int hot_pos = -1;
 		int hot_pos = -1;

+ 1 - 1
Views/Label.cs

@@ -15,7 +15,7 @@ namespace Terminal {
 	}
 	}
 
 
 	/// <summary>
 	/// <summary>
-	///   Label widget, displays a string at a given position, can include multiple lines.
+	/// Label view, displays a string at a given position, can include multiple lines.
 	/// </summary>
 	/// </summary>
 	public class Label : View {
 	public class Label : View {
 		List<string> lines = new List<string> ();
 		List<string> lines = new List<string> ();