dotnet/api-docs-sync

Automatically add boilerplate summary for auto-added parameterless constructors

carlossanlop opened this issue · 0 comments

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.