Is there a public method for getting doc from XML doc files?

SyntaxEditor .NET Languages Add-on for WPF Forum

Posted 8 years ago by Craig - Varigence, Inc.
Version: 11.1.0544
Avatar
If you select an item in an intelliprompt completion list, a info popup appears next to it, with information about the item and a green line containing any documentation. I've noticed that the C# completion provider can process documentation that's inside a XML doc file that's built with my .net project. I'm curious if the methods you use to obtain the documentation string from the XML doc are public so I can use them in my own completion providers.

Thanks,

-Craig

[Modified at 09/01/2011 11:56 AM]

Comments (1)

Posted 8 years ago by Actipro Software Support - Cleveland, OH, USA
Avatar
Hi Craig,

Yes, each IAssembly has a Documentation property which can be used to retrieve known documentation for a type or member. So once you figure out which assembly defines the type/member you can do:
var docProvider = assembly.Documentation.GetDocumentation(typeDef);
if (docProvider != null) {
    var comment = docProvider.GetSummary();
    ...
}


Actipro Software Support

The latest build of this product (v2018.1 build 0675) was released 1 month ago, which was after the last post in this thread.

Add Comment

Please log in to a validated account to post comments.