Thank you for your quick attention Eric! I appreciate it.
I understand that "The param element is mainly to describe the purpose of the parameter."
When you say: Your XML comments don't need to list it [the value type].
Are you saying I don't need this bit in the XML?
Type: <see cref="T:System.String"
Will Sandcastle still generate the type information without it?
We need the type information defined for each parameter of the method, like so:
The IP address to the server.
What is odd is that when the Type for Properties is created in the HTML, there is no problem at all.
Example XML code for Properties:
Type: <see cref="T:System.String" /><para>Specifies the name of the output file after the conversion.</para>
<remarks><para>Deprecated. Specify the output filename in the Convert methods.</para></remarks></summary>
Resulting HTML code for property value information as viewed in browser:
HTML code produced by Sandcastle:
<h4 class="subHeading">Property Value</h4>Type: <span class="nolink">String</span>
Now this XML code for Properties is just about identical to the XML code for Methods (see my first post),
And the output is just as expected, one instance of the parameter description.
I wonder why Sandcastle handles what looks to be like identical XML structure so differently.
- Is something I can do to get Sandcastle to treat the XML information for method parameters the same way it treats the XML code for properties parameters (one instance of the definition for Type)?
*OR.. If I go through our IntelliSense and remove all the
Type: <see cref="T:System.String
Will I still get:
in the output?
Thanks for your time and help,