Added documentation
9099e0e7
Aaron Campf
committed
1 changed file
FilterItem.cs
/Shell/FilterItem.cs-1+10
/Shell/FilterItem.cs
Add comment 35 Filter = filter;
Add comment 36 }
Add comment 37
Add comment 38 Plus   /// <summary>
Add comment 39 Plus   /// Splits the filter, trims the results then return all that contain that equal the filter
Add comment 40 Plus   /// </summary>
Add comment 41 Plus   /// <param name="filter">The string you are looking for</param>
Add comment 42 Plus   /// <returns></returns>
Add comment 38 43 public bool Contains(string filter)
Add comment 39 44 {
Add comment 40 45 return Filter.Split(',').Any(x => x.Trim() == filter);
Add comment 41 46 }
Add comment 42 47
Add comment 48 Plus   /// <summary>
Add comment 49 Plus   /// Returns a string that represents the current object.
Add comment 50 Plus   /// </summary>
Add comment 51 Plus   /// <returns>A string that represents the current object.</returns>
Add comment 43 52 public override string ToString()
Add comment 44 53 {
Add comment 45 54 string filterString = $" ({Filter})";
Add comment 59 68 /// </summary>
Add comment 60 69 /// <param name="filterString">The string representing a list of filters like: "txt|All files|"</param>
Add comment 61 70 /// <param name="existing">Not Sure</param>
Add comment 62 Minus   /// <param name="existingIndex">Not Sure</param>
Add comment 71 Plus   /// <param name="existingIndex">Sets the index of the currently selected item in the <see cref="FileFilterComboBox"/></param>
Add comment 63 72 /// <returns></returns>
Add comment 64 73 public static FilterItem[] ParseFilterString(string filterString, string existing, out int existingIndex)
Add comment 65 74 {