xml docs and typo

Author: tznind

src/ArrayExtensions.cs

@@ -31,6 +31,12 @@ public static class ArrayExtensions
         return toReturn;
     }
 
+    /// <summary>
+    /// Converts an enumerable to a <see cref="IListDataSource"/>
+    /// </summary>
+    /// <param name="enumerable"></param>
+    /// <returns></returns>
+    /// <exception cref="Exception"></exception>
     public static IListDataSource ToListDataSource(this IEnumerable enumerable)
     {
         // Get the type of the elements

src/Operations/IOperation.cs

@@ -33,7 +33,7 @@ public interface IOperation
     /// <summary>
     ///   Gets the number of times this <see cref="IOperation"/> has been executed successfully
     /// </summary>
-    ref int TimesDone { get; }
+    int TimesDone { get; }
 
     /// <summary>
     /// Performs the operation.

src/Operations/Operation.cs

@@ -8,7 +8,10 @@ namespace TerminalGuiDesigner.Operations;
 /// </summary>
 public abstract class Operation : IOperation
 {
-    protected int _timesDone;
+    /// <summary>
+    /// The number of times the operation has been performed.
+    /// </summary>
+    private int _timesDone;
 
     /// <summary>
     /// The name to give to all objects which do not have a title/text etc.
@@ -23,7 +26,7 @@ public abstract class Operation : IOperation
     public bool SupportsUndo { get; protected set; } = true;
 
     /// <inheritdoc />
-    public ref int TimesDone => ref _timesDone;
+    public int TimesDone => _timesDone;
 
     /// <inheritdoc/>
     /// <remarks>Defaults to <see cref="Guid.NewGuid"/>.</remarks>
@@ -66,6 +69,7 @@ public void Undo()
         UndoImpl();
     }
 
+    /// <inheritdoc cref="Undo"/>
     protected abstract void UndoImpl();
 
     /// <inheritdoc/>
@@ -75,6 +79,7 @@ public void Redo()
         RedoImpl();
     }
 
+    /// <inheritdoc cref="Redo"/>
     protected abstract void RedoImpl();
 
     /// <inheritdoc cref="IOperation.Do"/>

src/StatusBarExtensions.cs

@@ -68,11 +68,23 @@ public static int CountShortcuts(this StatusBar bar)
         return bar.Subviews.OfType<Shortcut>().Count();
     }
 
+    /// <summary>
+    /// Returns the items on the <see cref="StatusBar"/> (previously
+    /// called StatusBarItems now called just <see cref="Shortcut"/>)
+    /// </summary>
+    /// <param name="bar"></param>
+    /// <returns></returns>
     public static Shortcut[] GetShortcuts(this StatusBar bar)
     {
         return bar.Subviews.OfType<Shortcut>().ToArray();
     }
 
+    /// <summary>
+    /// Replaces all items on the <paramref name="bar"/> with the new
+    /// <paramref name="shortcuts"/>.
+    /// </summary>
+    /// <param name="bar"></param>
+    /// <param name="shortcuts"></param>
     public static void SetShortcuts(this StatusBar bar, Shortcut[] shortcuts)
     {
         foreach(var old in bar.GetShortcuts())

src/ToCode/EnumToCode.cs

@@ -2,18 +2,31 @@
 
 namespace TerminalGuiDesigner.ToCode;
 
+/// <summary>
+/// Code generation methods for writing out enum values
+/// using CodeDom.
+/// </summary>
 public class EnumToCode : ToCodeBase
 {
     private readonly Enum value;
     private readonly Type enumType;
 
-
+    /// <summary>
+    /// Creates a new instance of the class, primed to generate code
+    /// for the supplied <paramref name="value"/>
+    /// </summary>
+    /// <param name="value"></param>
     public EnumToCode(Enum value)
     {
         this.value = value;
         this.enumType = value.GetType();
     }
 
+    /// <summary>
+    /// <para>Returns code expression similar to <c>MyEnum.SomeValue</c>.</para>
+    /// <para>Supports Flags enums e.g. generating things like <c>MyEnum.ValA | MyEnum.ValB</c></para>
+    /// </summary>
+    /// <returns></returns>
     public CodeExpression ToCode()
     {
         var isFlags = enumType.IsDefined(typeof(FlagsAttribute), false);

src/ToCode/InstanceOfProperty.cs

@@ -11,12 +11,25 @@ namespace TerminalGuiDesigner.ToCode;
 /// </summary>
 public class InstanceOfProperty : Property
 {
-    public Type MustBeDerrivedFrom { get; }
+    /// <summary>
+    /// Places a restriction on the <see cref="Property.SetValue"/> that
+    /// can be supplied. When setting the value must be a class derrived
+    /// from this <see cref="Type"/>.
+    /// </summary>
+    public Type MustBeDerivedFrom { get; }
 
+    /// <summary>
+    /// Creates a new instance of designable property <paramref name="property"/>.
+    /// In which values set <see cref="MustBeDerivedFrom"/> the supplied
+    /// <see cref="PropertyInfo.PropertyType"/>
+    /// </summary>
+    /// <param name="design"></param>
+    /// <param name="property"></param>
+    /// <exception cref="Exception"></exception>
     public InstanceOfProperty(Design design, PropertyInfo property)
         : base(design, property)
     {
-        this.MustBeDerrivedFrom = property.PropertyType
+        this.MustBeDerivedFrom = property.PropertyType
             ?? throw new Exception("Unable to determine property type");
     }
 

src/UI/KeyMap.cs

@@ -176,8 +176,7 @@ public KeyMap( )
     public string ToggleDragging { get; init; } = ToggleDragging;
 
     /// <summary>
-    ///   Gets the string to toggle showing dotted borders around views that otherwise do not have visible borders (e.g.
-    ///   <see cref="ScrollView" />).
+    ///   Gets the string to toggle showing dotted borders around views that otherwise do not have visible borders.
     /// </summary>
     public string ToggleShowBorders { get; init; } = ToggleShowBorders;
 

src/UI/KeyboardManager.cs

@@ -30,7 +30,7 @@ public KeyboardManager(KeyMap keyMap)
     /// to the rest of the regular Terminal.Gui API layer.
     /// </summary>
     /// <param name="focusedView">The <see cref="View"/> that currently holds focus in <see cref="Editor"/>.</param>
-    /// <param name="keystroke">The key that has been reported by <see cref="Application.RootKey"/>.</param>
+    /// <param name="keystroke">The key that has been reported by <see cref="Application.KeyDown"/>.</param>
     /// <returns><see langword="true"/> if <paramref name="keystroke"/> should be suppressed.</returns>
     public bool HandleKey(View focusedView, Key keystroke)
     {

src/UI/MouseManager.cs

@@ -34,7 +34,7 @@ public class MouseManager
     /// Responds to <see cref="Application.MouseEvent"/>(by changing a 'drag a box' selection area
     /// or starting a resize etc).
     /// </summary>
-    /// <param name="m">The <see cref="MouseEventArgs"/> reported by <see cref="Application.RootMouseEvent"/>.</param>
+    /// <param name="m">The <see cref="MouseEventArgs"/> reported by <see cref="Application.MouseEvent"/>.</param>
     /// <param name="viewBeingEdited">The root <see cref="Design"/> that is open in the <see cref="Editor"/>.</param>
     public void HandleMouse(MouseEventArgs m, Design viewBeingEdited)
     {

src/UI/ValueFactory.cs

@@ -246,7 +246,7 @@ internal static bool GetNewValue(Design design, Property property, object? oldVa
                 if (Modals.Get<Type>(
                     property.PropertyInfo.Name,
                     "New Value",
-                    typeof(Label).Assembly.GetTypes().Where(inst.MustBeDerrivedFrom.IsAssignableFrom).ToArray(),
+                    typeof(Label).Assembly.GetTypes().Where(inst.MustBeDerivedFrom.IsAssignableFrom).ToArray(),
                     inst.GetValue()?.GetType(),
                     out Type? typeChosen))
                 {