Skip to content

Implement doc coverage for C# enums #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Smaug123 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Implement doc coverage for C# enums #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ApiSurface.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "ApiSurface.SampleAssembly",
EndProject
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "ApiSurface.Test", "ApiSurface\Test\ApiSurface.Test.fsproj", "{2A7BE060-01B6-C8F9-6033-BFAAFC84BAF7}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ApiSurface.CSharpExample", "ApiSurface.CSharpExample\ApiSurface.CSharpExample.csproj", "{CF3C7214-2002-4CAE-AAB9-38AA44D1EEE6}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand All @@ -32,6 +34,10 @@ Global
{2A7BE060-01B6-C8F9-6033-BFAAFC84BAF7}.Debug|Any CPU.Build.0 = Debug|Any CPU
{2A7BE060-01B6-C8F9-6033-BFAAFC84BAF7}.Release|Any CPU.ActiveCfg = Release|Any CPU
{2A7BE060-01B6-C8F9-6033-BFAAFC84BAF7}.Release|Any CPU.Build.0 = Release|Any CPU
{CF3C7214-2002-4CAE-AAB9-38AA44D1EEE6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{CF3C7214-2002-4CAE-AAB9-38AA44D1EEE6}.Debug|Any CPU.Build.0 = Debug|Any CPU
{CF3C7214-2002-4CAE-AAB9-38AA44D1EEE6}.Release|Any CPU.ActiveCfg = Release|Any CPU
{CF3C7214-2002-4CAE-AAB9-38AA44D1EEE6}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
4 changes: 2 additions & 2 deletions ApiSurface/Test/ApiSurface.Test.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
<PropertyGroup>
<TargetFrameworks>net8.0</TargetFrameworks>
<NuGetAudit>false</NuGetAudit>
</PropertyGroup>
<PropertyGroup>
<IsPublishable>false</IsPublishable>
</PropertyGroup>
<ItemGroup>
<Compile Include="RedirectOutput.fs" />
<Compile Include="Sample.fs" />
<Compile Include="TestDocCoverage.fs" />
<Compile Include="TestDocCoverageCSharp.fs" />
<Compile Include="TestSemanticVersioning.fs" />
<Compile Include="TestSurface.fs" />
<Compile Include="TestSurfaceComparison.fs" />
Expand All @@ -31,6 +30,7 @@
<PackageReference Include="System.Xml.XDocument" Version="4.3.0" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\ApiSurface.CSharpExample\ApiSurface.CSharpExample.csproj" />
<ProjectReference Include="..\..\ApiSurface.DocumentationSample\ApiSurface.DocumentationSample.fsproj" />
<ProjectReference Include="..\..\ApiSurface\ApiSurface.fsproj" />
<ProjectReference Include="..\..\ApiSurface.SampleAssembly\ApiSurface.SampleAssembly.fsproj" />
Expand Down
13 changes: 13 additions & 0 deletions ApiSurface/Test/TestDocCoverageCSharp.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
namespace ApiSurface.Test

open ApiSurface
open NUnit.Framework

[<TestFixture>]
module TestDocCoverageCSharp =

let sampleAssembly = typeof<ApiSurface.CSharpExample.MyEnum>.Assembly

[<Test>]
let ``Test comparing with identical coverage`` () =
DocCoverage.assertFullyDocumented sampleAssembly
Loading