Skip to content

Make doc comments required on public APIs #12067

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.

Sign up for GitHub

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

Jump to bottom
Closed
davidfowl opened this issue Jul 10, 2019 · 3 comments · Fixed by #27515
Closed

Make doc comments required on public APIs #12067

davidfowl opened this issue Jul 10, 2019 · 3 comments · Fixed by #27515
Assignees
@JunTaoLuo
Labels
area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework task

Comments

@davidfowl
Copy link
Member

Now that we've moved away from pubternal APIs we should make it required to have public documentation on these APIs.
@mkArtakMSFT mkArtakMSFT added area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework PRI: 1 - Required task labels Jul 11, 2019
@dougbu
Copy link
Contributor

dougbu commented Sep 24, 2020

@mkArtakMSFT what is lacking here❔ Warnings about missing XML documentation (CS1591) will break builds as soon as https://github.com/dotnet/aspnetcore/blob/master/Directory.Build.props#L102-L103 is removed. Suggest assigning to someone on your team to see where we aren't fully documenting the public APIs. Up to you whether this is needed in 5.0.

@dougbu
Copy link
Contributor

dougbu commented Oct 21, 2020

See resolution of #26397

This was referenced Oct 22, 2020
Closed
Closed
@JunTaoLuo JunTaoLuo mentioned this issue Nov 4, 2020
Merged
@JunTaoLuo
Copy link
Contributor

Followup in #27538 for what's still missing in terms of API docs.

@ghost ghost locked as resolved and limited conversation to collaborators Dec 5, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JunTaoLuo JunTaoLuo

Labels
area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework task
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Enable API doc checks by default dotnet/aspnetcore
5 participants
@davidfowl @pranavkm @JunTaoLuo @dougbu @mkArtakMSFT