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

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

Open
carlossanlop opened this issue Sep 23, 2022 · 0 comments
Labels
port-to-docs Issues related to the PortToDocs tool.

Comments

@carlossanlop
Copy link
Member

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
port-to-docs Issues related to the PortToDocs tool.
Projects
None yet
Development

No branches or pull requests

1 participant