search

Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.
MIT No Attribution
160 stars 26 forks source link

Using DefaultDocumentation programmatically within a C# class? #155

Open princefishthrower opened 8 months ago

princefishthrower commented 8 months ago

Hi, I was trying to see examples of how to use this library programmatically directly in C# (for example, given the path to an XML file, create a markdown string), i.e.: 

var myMarkdownString = DefaultDocumentation.GenerateMarkdown(myXMLString)

but I couldn't find anything.

I realize there are other ways to use this library, but our use case is a bit "special" (we need to modify markdown in place of an existing markdown document).

Are there code samples I somehow missed somewhere?

Thanks!

Doraku commented 8 months ago

hum the generation is based on the actual binary output, completed with the xml documentation. On its own the xml documentation is missing a lot of information :/ You could create the DocItems needed by hand but it would probably be easier to copy the DocItemReader, kinda doing your own Common logic which is actually the orchestrator of everything. Not sure if that would fit your need as it was definitely not made with this usage in mind.