Skip to content

Automatically add boilerplate summary for auto-added parameterless constructors #132

Open

Description

@carlossanlop

HalfConverter, Int128Converter or UInt128Converter, have their documentation xml file created in this location:

runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml

None of these 3 APIs have an xml entry for a parameterless constructor, but it gets added to the dotnet-api-docs file automatically anyway. According to this programming guide doc, it's valid.

To fix this:

  • We need to agree on a generic boilerplate message that would apply to all APIs. Something like:

Creates a new <see cref=”T:Full.Name.Of.Type”/> instance with default values.

  • We need investigate if it’s possible to determine if a parameterless constructor was autogenerated by the compiler and that’s why I was unable to find its docs in the intellisense xml files, or if the problem was that the user provided the wrong artifacts path which does not contain the xml file with that type’s docs.

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

    port-to-docsIssues related to the PortToDocs tool.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions