Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using DefaultDocumentation programmatically within a C# class? #155

Open
princefishthrower opened this issue Mar 18, 2024 · 1 comment
Open

Comments

@princefishthrower
Copy link

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
Copy link
Owner

Doraku commented Mar 20, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants