Add XML documentation (#10)

The prior `///` F# documentation blocks were not rendering in IDEs, and parameters were not documented. This change adds complete XML documentation to all (but `Compat`) classes, methods, and functions.

Reviewed-on: #10
This commit was merged in pull request #10.
This commit is contained in:
2024-12-30 22:03:18 +00:00
parent 147a72b476
commit 5580284910
13 changed files with 3412 additions and 1627 deletions

View File

@@ -75,7 +75,7 @@ public static class SqliteCSharpTests
]),
TestCase("WhereById succeeds", () =>
{
Expect.equal(Sqlite.Query.WhereById("@id"), "data->>'Id' = @id", "WHERE clause not correct");
Expect.equal(Sqlite.Query.WhereById("abc"), "data->>'Id' = @id", "WHERE clause not correct");
}),
TestCase("Patch succeeds", () =>
{
@@ -141,9 +141,9 @@ public static class SqliteCSharpTests
Expect.isEmpty(Parameters.None, "The parameter list should have been empty");
})
]);
// Results are exhaustively executed in the context of other tests
/// <summary>
/// Add the test documents to the database
/// </summary>
@@ -989,7 +989,7 @@ public static class SqliteCSharpTests
})
])
]);
/// <summary>
/// All tests for SQLite C# functions and methods
/// </summary>