XML documentation - problems with lists

  • Thread starter Thread starter Bikhod
  • Start date Start date
B

Bikhod

Hi

Refering to my sample below, can anyone please tell me why my list is
not appearing correctly on my VS.NET generated web site?

The summary and remarks are fine, but the HTML is showing the list as

Invariants of a stack: <list type="bullet"> <item>Count must be
positive</item> <item>Count can not exceed capacity</item> <item>Empty
if no elements</item> </list>


-----------------------------------------------

/// <summary>
/// Invariants of a stack:
/// <list type="bullet">
/// <item>Count must be positive</item>
/// <item>Count can not exceed capacity</item>
/// <item>Empty if no elements</item>
/// </list>
/// </summary>
/// <param name="source">blah blah.</param>
/// <param name="stack">more blah</param>
[Conditional("DEBUG")]
public void Invariants(string source, IStack stack)
{
}
 
Hi Bikhod,

First of all, I would like to confirm my understanding of your issue. From
your description, I understand that your comment web page is built with the
xml tags instead of content only. If there is any misunderstanding, please
feel free to let me know.

Based on my research, you're receiving this, because the HTML in comments
are displayed as text. To avoid this, when you have selected Build Comment
Web Pages from the menu, you have to uncheck the For security, display HTML
in comments as text checkbox and rebuild the web pages.

HTH.

Kevin Yu
=======
"This posting is provided "AS IS" with no warranties, and confers no
rights."
 
Hi Kevin

I unchecked the For security option that you described below and now I
get a different behaviour. The HTML tags no longer appear, however, I
still don't get my bulleted list.

Has anyone ever managed to get any list appear in their VS.NET
generated web site? If so, what did you do?

Thanks
bikohd
 
Hi Bikhod,

We have reviewed this issue and are currently researching on it. We will
update you ASAP. Thanks for your patience!

Kevin Yu
=======
"This posting is provided "AS IS" with no warranties, and confers no
rights."
 
Hi Bikhod,

The Comment Web Page (HTML) is different from XML Documentation.

Code comment Web reports recognize the following XML tags:

<summary></summary> Describes a member for a type.
<remarks></remarks> Specifies overview information for a class or other
type.
<param></param> Used in the comment for a method declaration to describe
one of the parameters for the method.
<returns></returns> Used in the comment for a method declaration to
describe the return value.
<newpara></newpara> Starts a new paragraph in the comments.

For more information, please check the Creating Code Reports:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vsintro7/ht
ml/vxconCommentingCode.asp?frame=true

It does not recognize the <list> tag, which is a commonly used XML tag. You
may need to render the HTML on your own, or use XSLT to transform the XML
Documentation to HTML.

Kevin Yu
=======
"This posting is provided "AS IS" with no warranties, and confers no
rights."
 
Hi Bikhod,

I'd like to know if this issue has been resolved yet. Is there anything
that I can help. I'm still monitoring on it. If you have any questions,
please feel free to post them in the community.

Kevin Yu
=======
"This posting is provided "AS IS" with no warranties, and confers no
rights."
 
Back
Top