I have a Visual Studio C# project with XML documentation comments. I get a .xml
file with <summary>
, <param>
, <returns>
and <example>
members.
The text I put inbetween the <summary>
tags is shown in the help file as well as Namespace
, Assembly
, Example
and See Also
sections. Just <param>
and <returns>
don't even have an empty section even though it builds with no errors.
Relevant part of the generated .xml
:
<member name="M:OPC_ClientLib.OPC_Client.getBit(System.String)">
<summary> the summary text (is shown) </summary>
<param name="variable">Variable name (not shown)</param>
<returns>true or false, (not shown)</returns>
<example>
<code> bool bit = getBit("bitname")</code>
</example>
</member>
Actual output
I use Sandcastle Help File Builder GUI Version 2018.5.29.0.
I tried to show anything in the project properties which gave me a lot of unwanted extra elements in the documentation but none of which got me <return>
or <params>
.
bool bit = getBit("bitname")