question

AlexGShushanikoff-5757 avatar image
0 Votes"
AlexGShushanikoff-5757 asked ·

Adding xml documentation for a dll (C++)

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-supported
10 |1000 characters needed characters left characters exceeded

Up to 10 attachments (including images) can be used with a maximum of 3.0 MiB each and 30.0 MiB total.

1 Answer

FayWang-MSFT avatar image
0 Votes"
FayWang-MSFT answered ·

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.


·
10 |1000 characters needed characters left characters exceeded

Up to 10 attachments (including images) can be used with a maximum of 3.0 MiB each and 30.0 MiB total.