arcade icon indicating copy to clipboard operation
arcade copied to clipboard

Including xml documentation of methods in the Generated CS file

Open ratishphilip opened this issue 8 years ago • 7 comments

In the .CS file which is generated by the Microsoft.DotNet.BuildTools.GenAPI package, is it possible to include the xml documentation of the methods which are listed for each types listed in the file?

ratishphilip avatar Mar 01 '17 06:03 ratishphilip

I'm guessing this is a possible feature if the xml docs file exists but it isn't likely something that is on our radar. @ratishphilip is this a feature you would be interested in adding?

weshaggard avatar Mar 01 '17 23:03 weshaggard

@weshaggard I can certainly try that, if you could point me in the right direction where to begin.

ratishphilip avatar Mar 01 '17 23:03 ratishphilip

Load the solution file https://github.com/dotnet/buildtools/blob/master/src/BuildTools.sln and try adding an option to pass in the xml documentation file and then write some code to parse it and try to align the docids between the doc file and the model we are using to write the APIs.

weshaggard avatar Mar 01 '17 23:03 weshaggard

ok. Let me try that.

ratishphilip avatar Mar 01 '17 23:03 ratishphilip

@ratishphilip is this something you are still interested in pursing?

weshaggard avatar Apr 25 '17 16:04 weshaggard

I'm sorry. I won't be able to pursue this further.

ratishphilip avatar Apr 25 '17 22:04 ratishphilip

Is there a way to do this? We're facing some issues with missing XML tags too, wondering if there is an alternative route!

cheenamalhotra avatar Sep 21 '19 05:09 cheenamalhotra