docs

SimonCropp · Feb 18, 2024 · 2a4b91a · 2a4b91a
1 parent 797362f
commit 2a4b91a
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 1 deletion.
diff --git a/api_list.include.md b/api_list.include.md
@@ -290,3 +290,18 @@
  * `Boolean TryFormat(Span<Char>, Int32&, ReadOnlySpan<Char>, IFormatProvider)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.uint64.tryformat)
 
 
+### Static helpers
+
+#### EnumPolyfill
+
+ * `String[] GetNames<TEnum>()` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.enum.getnames)
+ * `TEnum[] GetValues<TEnum>()` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.enum.getvalues)
+
+
+#### RegexPolyfill
+
+ * `Boolean IsMatch(String, RegularExpressions.RegexOptions, TimeSpan)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.ismatch#system-text-regularexpressions-regex-ismatch(system-readonlyspan((system-char))-system-string-system-text-regularexpressions-regexoptions-system-timespan))
+ * `Boolean IsMatch(String, RegularExpressions.RegexOptions)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.ismatch#system-text-regularexpressions-regex-ismatch(system-readonlyspan((system-char))-system-string-system-text-regularexpressions-regexoptions))
+ * `Boolean IsMatch(String)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.ismatch#system-text-regularexpressions-regex-ismatch(system-readonlyspan((system-char))-system-string))
+
+
diff --git a/readme.md b/readme.md
@@ -645,6 +645,21 @@ The class `Polyfill` includes the following extension methods:
 
  * `Boolean TryFormat(Span<Char>, Int32&, ReadOnlySpan<Char>, IFormatProvider)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.uint64.tryformat)
 
+
+### Static helpers
+
+#### EnumPolyfill
+
+ * `String[] GetNames<TEnum>()` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.enum.getnames)
+ * `TEnum[] GetValues<TEnum>()` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.enum.getvalues)
+
+
+#### RegexPolyfill
+
+ * `Boolean IsMatch(String, RegularExpressions.RegexOptions, TimeSpan)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.ismatch#system-text-regularexpressions-regex-ismatch(system-readonlyspan((system-char))-system-string-system-text-regularexpressions-regexoptions-system-timespan))
+ * `Boolean IsMatch(String, RegularExpressions.RegexOptions)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.ismatch#system-text-regularexpressions-regex-ismatch(system-readonlyspan((system-char))-system-string-system-text-regularexpressions-regexoptions))
+ * `Boolean IsMatch(String)` [reference](https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.ismatch#system-text-regularexpressions-regex-ismatch(system-readonlyspan((system-char))-system-string))
+
 <!-- endInclude -->
 
 

diff --git a/src/Tests/BuildApiTest.cs b/src/Tests/BuildApiTest.cs
@@ -25,7 +25,8 @@ public void Run()
         var md = Path.Combine(solutionDirectory, "..", "api_list.include.md");
         File.Delete(md);
         using var module = ModuleDefinition.ReadModule(path);
-        var extensions = module.GetTypes().Single(_ => _.Name == nameof(Polyfill));
+        var types = module.GetTypes().ToList();
+        var extensions = types.Single(_ => _.Name == nameof(Polyfill));
         using var writer = File.CreateText(md);
 
         writer.WriteLine($"### Extension methods");
@@ -44,6 +45,25 @@ public void Run()
             writer.WriteLine();
             writer.WriteLine();
         }
+        writer.WriteLine($"### Static helpers");
+        writer.WriteLine();
+
+        WriteHelper(types, nameof(EnumPolyfill), writer);
+        WriteHelper(types, "RegexPolyfill", writer);
+    }
+
+    static void WriteHelper(List<TypeDefinition> types, string name, StreamWriter writer)
+    {
+        var helper = types.Single(_ => _.Name == name);
+
+        writer.WriteLine($"#### {helper.Name}");
+        writer.WriteLine();
+        foreach (var method in PublicMethods(helper.Methods))
+        {
+            WriteSignature(method, writer);
+        }
+        writer.WriteLine();
+        writer.WriteLine();
     }
 
     static string GetTypeName(string targetType)