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

[Feature Request] Include Document XML in NuGet packages #8944

Open
filzrev opened this issue Jul 7, 2023 · 0 comments
Open

[Feature Request] Include Document XML in NuGet packages #8944

filzrev opened this issue Jul 7, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation and the project website
Milestone

Comments

@filzrev
Copy link
Contributor

filzrev commented Jul 7, 2023

Is your feature request related to a problem? Please describe.
Intellisense is not works when using Microsoft.DocAsCode.App package.
Because NuGet package don't contains xml documentation files.

Describe the solution you'd like
Enable xml document generation by enabling following settings in `Directory.Build.Props.

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertGroup>

Currently 4000+ warnings generated when this settings enabled.
It needs to solve these warnings.

  • Change class visibility from public to internal if it's not intended used.
  • Disable GenerateDocumentationFile for test projects.
  • Add documentation comments.

Describe alternatives you've considered
Enable GenerateDocumentationFile only when creating NuGet packages .
And ignore warnings.

@yufeih yufeih added the documentation Improvements or additions to documentation and the project website label Jul 7, 2023
@yufeih yufeih added this to the Backlog milestone Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation and the project website
Projects
None yet
Development

No branches or pull requests

2 participants