Merge pull request #231 from miroiu/chore/docs

Update StringMath and generated API reference

Author: miroiu

CHANGELOG.md

@@ -25,7 +25,7 @@
 >	- Added the KeyComboGesture that requires a trigger key to be held down before pressing a combo key
 >	- Added FocusVisualPen and FocusVisualPadding dependency properties to BaseConnection
 >	- Added default focus visuals for base editor controls that can be included by referencing the FocusVisual.xaml file
->	- Added MaxHotKeys and HotKeysDisplayMode static configuration field to PendingConnection
+>	- Added MaxHotKeys and HotKeysDisplayMode static configuration fields to PendingConnection
 >	- Added HotKeyControl with its corresponding theme resources to display the hotkeys for a pending connection
 > - Bugfixes:
 

Examples/Nodify.Calculator/Nodify.Calculator.csproj

@@ -10,7 +10,7 @@
     <LangVersion>8.0</LangVersion>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="StringMath" Version="4.1.2" />
+    <PackageReference Include="StringMath" Version="4.1.3" />
   </ItemGroup>
 
   <ItemGroup>

docs/api/API-Reference.md

@@ -21,6 +21,8 @@
 - [EditorCommands Class](Nodify_EditorCommands)  
 - [GroupingMovementMode Enum](Nodify_GroupingMovementMode)  
 - [GroupingNode Class](Nodify_GroupingNode)  
+- [HotKeyControl Class](Nodify_HotKeyControl)  
+- [HotKeysDisplayMode Enum](Nodify_HotKeysDisplayMode)  
 - [INodifyCanvasItem Interface](Nodify_INodifyCanvasItem)  
 - [ItemContainer Class](Nodify_ItemContainer)  
 - [KnotNode Class](Nodify_KnotNode)  

docs/api/Nodify_HotKeyControl.md

@@ -0,0 +1,32 @@
+# HotKeyControl Class  
+  
+**Namespace:** Nodify  
+  
+**Assembly:** Nodify  
+  
+**Inheritance:** [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object) → [DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject) → [DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject) → [Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual) → [UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement) → [FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement) → [Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control) → [HotKeyControl](Nodify_HotKeyControl)  
+  
+```csharp  
+public class HotKeyControl : Control  
+```  
+  
+## Constructors  
+  
+### HotKeyControl()  
+  
+```csharp  
+public HotKeyControl();  
+```  
+  
+## Properties  
+  
+### Number  
+  
+```csharp  
+public int Number { get; set; }  
+```  
+  
+**Property Value**  
+  
+[Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32)  
+  

docs/api/Nodify_HotKeysDisplayMode.md

@@ -0,0 +1,40 @@
+# HotKeysDisplayMode Enum  
+  
+**Namespace:** Nodify  
+  
+**Assembly:** Nodify  
+  
+**References:** [PendingConnection](Nodify_PendingConnection)  
+  
+Specifies how hotkeys are displayed for a pending connection.  
+  
+```csharp  
+public enum HotKeysDisplayMode  
+```  
+  
+## Fields  
+  
+### All  
+  
+Display hotkeys for both mouse and keyboard.  
+  
+```csharp  
+All = 2;  
+```  
+  
+### Keyboard  
+  
+Display hotkeys for keyboard only.  
+  
+```csharp  
+Keyboard = 1;  
+```  
+  
+### None  
+  
+No hotkeys will be displayed for the pending connection.  
+  
+```csharp  
+None = 0;  
+```  
+  

docs/api/Nodify_PendingConnection.md

@@ -6,7 +6,7 @@
 
 **Inheritance:** [Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object) → [DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject) → [DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject) → [Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual) → [UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement) → [FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement) → [Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control) → [ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl) → [PendingConnection](Nodify_PendingConnection)  
 
-**References:** [ConnectionDirection](Nodify_ConnectionDirection), [Connector](Nodify_Connector), [ItemContainer](Nodify_ItemContainer), [NodifyEditor](Nodify_NodifyEditor), [PendingConnectionEventArgs](Nodify_Events_PendingConnectionEventArgs), [PendingConnectionEventHandler](Nodify_Events_PendingConnectionEventHandler), [StateNode](Nodify_StateNode)  
+**References:** [ConnectionDirection](Nodify_ConnectionDirection), [Connector](Nodify_Connector), [HotKeysDisplayMode](Nodify_HotKeysDisplayMode), [ItemContainer](Nodify_ItemContainer), [NodifyEditor](Nodify_NodifyEditor), [PendingConnectionEventArgs](Nodify_Events_PendingConnectionEventArgs), [PendingConnectionEventHandler](Nodify_Events_PendingConnectionEventHandler), [StateNode](Nodify_StateNode)  
 
 Represents a pending connection usually started by a [Connector](Nodify_Connector) which invokes the [PendingConnection.CompletedCommand](Nodify_PendingConnection#completedcommand) when completed.  
 
@@ -110,6 +110,18 @@ public bool EnableSnapping { get; set; }
 
 [Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean)  
 
+### HotKeysDisplayMode  
+  
+Gets or sets whether hotkeys are enabled for pending connections.  
+  
+```csharp  
+public static HotKeysDisplayMode HotKeysDisplayMode { get; set; }  
+```  
+  
+**Property Value**  
+  
+[HotKeysDisplayMode](Nodify_HotKeysDisplayMode)  
+  
 ### IsVisible  
 
 Gets or sets the visibility of the connection.  
@@ -122,6 +134,18 @@ public bool IsVisible { get; set; }
 
 [Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean)  
 
+### MaxHotKeys  
+  
+Gets or sets the maximum number of hotkeys that can be displayed for a pending connection.  
+  
+```csharp  
+public static uint MaxHotKeys { get; set; }  
+```  
+  
+**Property Value**  
+  
+[UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32)  
+  
 ### PreviewTarget  
 
 Gets or sets the [Connector](Nodify_Connector) or the [ItemContainer](Nodify_ItemContainer) (if [PendingConnection.AllowOnlyConnectors](Nodify_PendingConnection#allowonlyconnectors) is false) that we're previewing. See [PendingConnection.EnablePreview](Nodify_PendingConnection#enablepreview).