dotnet / dotnet/docfx

[Feature Request] Include Document XML in NuGet packages

Open
#8,944 0 comments 1 reaction 1 assignee Assigned to @Copilot View on GitHub
documentation
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**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.

```

true

```

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.