Skip to content

ts2Fable should generate empty param xml elements for parameters that are missing typescript comments #417

Description

@baronfel

Reecent F# compilers warn on missing param names in XML Documentation, so generated xmldocs should be exhaustive here to prevent confusion.

Here's a sample from generated vscode APIs:

    module Authentication =

        type [<AllowNullLiteral>] IExports =
            /// <summary>Register an authentication provider.
            /// 
            /// There can only be one provider per id and an error is being thrown when an id
            /// has already been used by another provider. Ids are case-sensitive.</summary>
            /// <param name="id">The unique identifier of the provider.</param>
            /// <param name="label">The human-readable name of the provider.</param>
            /// <param name="provider">The authentication provider provider.</param>
            abstract registerAuthenticationProvider: id: string * label: string * provider: AuthenticationProvider * ?options: AuthenticationProviderOptions -> Disposable

note the missing options parameter here, which causes FS3390 to be fired.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions