Add doc comment for GetCSVHeader

swisstopo · May 16, 2024 · 9cad78f · 9cad78f
1 parent ec8720b
commit 9cad78f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/api/BoreholeGeometryFormat/Helper.cs b/src/api/BoreholeGeometryFormat/Helper.cs
@@ -15,6 +15,12 @@ public static class Helper
         MissingFieldFound = null,
     };
 
+    /// <summary>
+    /// Get the CSV header <see cref="CsvHelper"/> expects to read a class <typeparamref name="T"/>.
+    /// Uses the map generated by <see cref="CsvHelper.CsvContext.AutoMap{T}()"/>.
+    /// If a property has multiple possible column names only the first is considered.
+    /// </summary>
+    /// <typeparam name="T">The class to get the header for.</typeparam>
     internal static string GetCSVHeader<T>()
     {
         var context = new CsvContext(CsvConfig);