Menu
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?
777
To insert XML comments for a code element Type /// in C#, or ''' in Visual Basic. From the Edit menu, choose IntelliSense > Insert Comment. From the right-click or context menu on or just above the code element, choose Snippet > Insert Comment.
Confluence is a flexible platform with a range of features and add-ons that can help you capture, distribute, and update your technical documentation. Below are some tips to help you get your technical documentation site started, and to save you time and effort managing your documentation's life cycle.
Documentation comments are similar to C# single-line comments, but start with /// (that's three slashes), and can be applied to any user-defined type or member. As well as containing descriptive text, these comments can also include embedded XML tags.
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://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/calling-a-web-api-from-a-net-client
120
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
