Skip to content

Overridden methods causes warnings due to missing documentation #41

Open
@VMelnalksnis

Description

@VMelnalksnis

Description
When OnPropertyChanged is overridden in a derived class it does not have XML comments, and so it causes a CS1591 warning.

To Reproduce
Set <GenerateDocumentationFile>true</GenerateDocumentationFile> in csproj, example with derived class from README - https://github.com/canton7/PropertyChanged.SourceGenerator#automatic-dependencies.

Version Info

  • PropertyChanged.SourceGenerator version: 1.0.8
  • Roslyn Version: Compiler version: '4.6.0-3.23259.8 (c3cc1d0c)'. Language version: 11.0.

Additional Info
In this case just adding /// <inheritdoc /> would be enough, and users of the library would be able to add the documentation if needed. I'm not sure if there are any other places where public/protected members could be generated. Another possibility might be to just add #pragma warning disable CS1591 in all generated files.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions