bit-badger/BitBadger.Documents
1
0
Fork 0
Code Issues Pull Requests Projects Releases 12 Activity

Add XML documentation (#10)

Browse Source 
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:
Daniel J. Summers
2024-12-30 22:03:18 +00:00
parent 147a72b476
commit 5580284910
13 changed files with 3412 additions and 1627 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Directory.Build.props
+6 -12
View File
@@ -2,18 +2,12 @@
<PropertyGroup>
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
<DebugType>embedded</DebugType>
<GenerateDocumentationFile>false</GenerateDocumentationFile>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<FileVersion>4.0.0.0</FileVersion>
<VersionPrefix>4.0.0</VersionPrefix>
<PackageReleaseNotes>From v3.1: (see project site for breaking changes and compatibility)
- Change ByField to ByFields
- Support dot-access to nested document fields
- Add Find*Ordered functions/methods
- Add case-insensitive ordering (as of rc2)
- Preserve additional ORDER BY qualifiers (as of rc3)
- Add In / InArray comparisons (as of rc4)
- Field construction functions are generic (as of rc5)</PackageReleaseNotes>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<FileVersion>4.0.1.0</FileVersion>
<VersionPrefix>4.0.1</VersionPrefix>
<PackageReleaseNotes>From v4.0: Add XML documention (IDE support)
From v3.1: See 4.0 release for breaking changes and compatibility</PackageReleaseNotes>
<Authors>danieljsummers</Authors>
<Company>Bit Badger Solutions</Company>
<PackageReadmeFile>README.md</PackageReadmeFile>