Adding xml documentation for a dll (C++)

AG Fox 1 Reputation point
2020-05-17T05:16:56.877+00:00

I have a dll in my C++ project's bin folder (somedll.dll) and everything works fine. But I want to add descriptions for some methods to be displayed by IntelliSense (VS 2017).
Is it enough to add an xml-file having the same name as the dll in the same folder right next to it (somedll.xml) looking somewhat like this:

    <?xml version="1.0"?>
    <doc>
        <assembly>
           <name>somedll</name>
        </assembly>
        <members>
     <member name="M:SomeNamespace.SomeClass.getNumAncestors">
     <summary>
     Returns an ancestor of the element by its index.
     </summary> 
     <returns>Element, if it exists.</returns>
     </member>
            <member name="M:SomeNamespace.SomeClass.getElementById(System.Int32)">
     <summary>
     Returns an element by its identifier.
     </summary> 
     <param name="element_id">Element ID.</param>
     <returns>Element, if it exists.</returns>
     </member>
        </members>
    </doc>

Or there's something else I have to do?

Not Monitored
Not Monitored
Tag not monitored by Microsoft.
37,786 questions
0 comments No comments
{count} votes

1 answer

Sort by: Most helpful
  1. Fay Wang - MSFT 5,206 Reputation points
    2020-05-18T09:59:17.437+00:00

    Hello,

    Welcome to Microsoft Q&A!

    Currently, all the supported topics are on the right top. Not all topics are supported in Microsoft Q&A.

    Your question is about c++, you can go to this forum to ask it.

    Thanks.

    0 comments No comments