Is there a way to generate a documentation wiki for github from my XML documentation comments in C#? [closed]

Question

I want to generate API documentation for my open source project on Github. I'd like to create them automatically from my XML Documentation Comments in my C# projects. My feeble googling has turned up bubkiss. Is there a way to do this?

I'd prefer it be in Github-style Markdown.

Answer 1

Here's an online C# XML doc to Markdown converter: http://varus.io/vsdoc-2-md/

It is based on @formixian's algorithm.

Answer 2

After searching around a bit, I found this gem of a gist:

Generates Markdown from VS XML documentation file

It prints to the C# XML -> markdown to the console. I'm sure it can be refined further, but this is a really great start. I've tested it, and it's totally working.

Answer 3

I ended up using Sandcastle to generate plain HTML and using that. Inevitably, I'll just write my own parser or a custom template for Sandcastle.

I didn't like the learning curve for Doxygen or QDoc.

Answer 4

I would recommend Doxygen. By configuring Doxygen using the configure files and XSLT you can pretty much do anything with it. http://www.doxygen.nl/

Set the source files and output in the configuration files, then use XSLT to customize the output.

For Doxygen there is a parser tool (http://code.google.com/p/doxygenxmlparser/) already prepared to do much of the work with C#

if(youDoNotLikeThisIdea == true) Another tool that is highly configurable would be QDoc (part of the Qt API) @ http://qt-project.org. Of course, using QDoc would require you to build Qt and QDoc in particular.

Good luck!