RicoSuter/Namotion.Reflection

How to set custom XML docs path

Open

#23 opened on Oct 31, 2019

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

Repository metrics

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

Description

Hi,

I'm trying to help with the following issue that generates documentation via NSwag in Azure Functions v2. I know what the problem is but I need to determine where NSwag get's the xml documentation from.

I think it's coming from this package.

In order to solve the issue, I need to be able to set a custom xml file path. In Azure Functions on the server, this is different then the path when you locally develop. So I tracked the code through NSwag to this package and ended up with the method GetXmlDocsPath.

So the ultimate questions are:

  1. Is this the correct line that NSwag is using to obtain the XML file for the documentation?
  2. If so, How can I set a custom path to the XML file in NSwag and then of course here in this package?

Contributor guide

Research direction
Identify where NSwag loads XML documentation paths and determine how to inject a custom path.
Tech stack
csharp
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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#.NETAzure Functions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40