Search code examples
.netdocumentationcommentsdocumentation-generationconfluence

How can I get my .NET XML Documentation Comments into Conflunce

I'd like to import my .Net XML Documentation Comments (the documentation based on the code tags, automatically generated by the compiler with the /doc switch) into Atlassian Confluence.

I've used Doxygen to generate some HTML which looks great, but I'd love to have something I can dump straight into Confluence.

Any ideas?

Solution

  • The straighforward and easy to maintain option would be to call the Confluence API to upload content; it is well documented so it should be the same as calling any REST API from .Net, once you have the content as you indicate.

    https://docs.atlassian.com/confluence/REST/latest/#content-createContent

    EDIT: while there are many questions in SO addressing how to call an API from .Net, just to have the full reference:

    https://learn.microsoft.com/en-us/aspnet/web-api/overview/advanced/calling-a-web-api-from-a-net-client