Skip to content
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.

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

Unable to document enums #87

Open
ChrisCanCompute opened this issue Sep 10, 2024 · 0 comments
Open

Unable to document enums #87

ChrisCanCompute opened this issue Sep 10, 2024 · 0 comments

Comments

@ChrisCanCompute
Copy link

ChrisCanCompute commented Sep 10, 2024

Using:

    <TargetFrameworks>net6.0</TargetFrameworks>

I've got the following F# code:

/// A Foo enum
type Foo =
    /// The bar case
    | Bar = 0

I would expect this to pass the documentation check.

Instead I get:

The following 1 member(s) are only in 'Test.xml':
  + F:Test.Foo.Bar

The following 2 member(s) are only in 'Test.dll':
  - P:Test.Foo.Bar
  - F:Test.Foo.value__

So I checked the readme, and tried to do:

/// A Foo enum
[<Undocumented>]
type Foo =
    /// The bar case
    | Bar = 0

But that attribute doesn't exist :'(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant