Added Xml Documentation

Author: Dirkster99

source/FilterTreeView/FilterTreeView.csproj

@@ -143,9 +143,7 @@
   <ItemGroup>
     <Resource Include="Resources\Locations\appbar.chess.rook.png" />
   </ItemGroup>
-  <ItemGroup>
-    <Folder Include="Models\" />
-  </ItemGroup>
+  <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.

source/FilterTreeView/MainWindow.xaml

@@ -68,6 +68,7 @@
                 <TextBox Grid.Column="0" Margin="3"
                      Text="{Binding SearchString}"
                      x:Name="FilterTextBox"
+                     ToolTip="Enter at least 3 chracters"
                      behav:TextChangedCommand.ChangedCommand="{Binding SearchCommand}"
                 />
 

source/FilterTreeView/SearchModels/SearchParams.cs

@@ -1,8 +1,16 @@
 namespace FilterTreeView.SearchModels
 {
+    /// <summary>
+    /// Implements a search object that contains the search string,
+    /// related options, as well as methods to determine whether a
+    /// given string is a match against the string or not.
+    /// </summary>
     internal class SearchParams
     {
         #region constructors
+        /// <summary>
+        /// Class constructor
+        /// </summary>
         public SearchParams(
               string searchString
             , Enums.SearchMatch match)
@@ -12,6 +20,9 @@ string searchString
             Match = match;
         }
 
+        /// <summary>
+        /// Class constructor
+        /// </summary>
         public SearchParams()
         {
             SearchString = string.Empty;
@@ -21,10 +32,19 @@ public SearchParams()
         #endregion constructors
 
         #region properties
+        /// <summary>
+        /// Gets the plain text string being searched or filtered.
+        /// </summary>
         public string SearchString { get; private set; }
 
+        /// <summary>
+        /// Gets the string being searched or filtered.
+        /// </summary>
         public Enums.SearchMatch Match { get; private set; }
 
+        /// <summary>
+        /// Gets whether search string contains actual content or not.
+        /// </summary>
         public bool IsSearchStringEmpty
         {
             get
@@ -33,10 +53,20 @@ public bool IsSearchStringEmpty
             }
         }
 
+        /// <summary>
+        /// Gets the minimal search string length required.
+        /// Any string shorter than this will not be searched at all.
+        /// </summary>
         public int MinimalSearchStringLength { get; }
         #endregion properties
 
         #region methods
+        /// <summary>
+        /// Determines if a given string is considered a match in comparison
+        /// to the search string and its options or not.
+        /// </summary>
+        /// <param name="stringToFind"></param>
+        /// <returns>true if <paramref name="stringToFind"/>is a match, otherwise false</returns>
         public bool MatchSearchString(string stringToFind)
         {
             stringToFind = (stringToFind == null ? string.Empty : stringToFind);
@@ -57,11 +87,18 @@ public bool MatchSearchString(string stringToFind)
             }
         }
 
+        /// <summary>
+        /// Can be called to trim the search string before matching takes place.
+        /// </summary>
         public void SearchStringTrim()
         {
             SearchString = SearchString.Trim();
         }
 
+        /// <summary>
+        /// Can be called to convert the search string
+        /// to upper case before matching takes place.
+        /// </summary>
         public void SearchStringToUpperCase()
         {
             SearchString = SearchString.ToUpper();

source/FilterTreeView/ViewModels/Search/BackupNodeSearch.cs

@@ -9,6 +9,11 @@
     using System.Windows;
     using System.Windows.Threading;
 
+    /// <summary>
+    /// Implements a set of methods to search and filter through backup nodes
+    /// and make them visible for binding only if the node is regarded as a match
+    /// against the search criteria.
+    /// </summary>
     internal class BackupNodeSearch
     {
         private static DispatcherPriority _ChildrenEditPrio = DispatcherPriority.DataBind;