Add example to PatterScanner.ParsePattern method comment

LeagueRaINi · Jul 7, 2020 · 0b8c34b · 0b8c34b
1 parent 8adbf24
commit 0b8c34b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/UE3Plugin/UE3Plugin/Utils/PatternScanner.cs b/UE3Plugin/UE3Plugin/Utils/PatternScanner.cs
@@ -11,6 +11,16 @@ internal static class PatternScanner
         /// <summary>
         /// Parses a pattern to a byte array.
         /// </summary>
+        /// <example>
+        /// Supported pattern structures:
+        ///     with capture group:
+        ///         "E8 [....] 48 83 CB FF 45 85 F6"
+        ///         "E8 (....) 48 83 CB FF 45 85 F6"
+        ///     without:
+        ///         "E8 .... 48 83 CB FF 45 85 F6"
+        ///         "E8 ? ? ? ? 48 83 CB FF 45 85 F6"
+        ///         "E8 ?? ?? ?? ?? 48 83 CB FF 45 85 F6"
+        /// </example>
         /// <param name="pattern">The pattern.</param>
         /// <param name="offset">The offset.</param>
         static List<byte?> ParsePattern(string pattern, out int offset)