RicoSuter/Namotion.Reflection

Documentation not being generated for models from NuGet packages

Open

#33 opened on Jan 9, 2020

View on GitHub
 (22 comments) (1 reaction) (0 assignees)C# (50 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (235 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I have some models exposed in my APIs that come from NuGetPackages.

While those types are properly documented (I can see the doc in intellisense), they have no documentation in the generated OpenApi spec.

This does not happen on netcoreapp2.1, but does happen on netcoreapp3.1.

To highlight this issue, please see this repro: 3.1 branch : https://github.com/jeremyVignelles/TestNSwagNetCoreApp/blob/repro/doc-external-models/TestNSwagNetCoreApp/Hello.cs#L42

2.1 branch: https://github.com/jeremyVignelles/TestNSwagNetCoreApp/blob/repro/doc-external-models-netcoreapp2.1/TestNSwagNetCoreApp/Hello.cs#L42

I used a type from the NSwag NuGet package to highlight the issue.

Contributor guide

Research direction
Investigate the XML documentation generation pipeline for external types from NuGet packages, comparing behavior between .NET Core 2.1 and 3.1. Focus on how the reflection library loads and processes XML doc files for referenced assemblies.
Tech stack
csharp
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#.NET
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70