473,785 Members | 2,425 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

XML documentation - problems with lists

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">b lah blah.</param>
/// <param name="stack">mo re blah</param>
[Conditional("DE BUG")]
public void Invariants(stri ng source, IStack stack)
{
}
Nov 16 '05 #1
5 1343
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 misunderstandin g, 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."

Nov 16 '05 #2
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
v-****@online.mic rosoft.com (Kevin Yu [MSFT]) wrote in message news:<mY******* *******@cpmsftn gxa10.phx.gbl>. ..
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 misunderstandin g, 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."

Nov 16 '05 #3
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."

Nov 16 '05 #4
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/de...us/vsintro7/ht
ml/vxconCommenting Code.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."

Nov 16 '05 #5
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."

Nov 16 '05 #6

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

11
6073
by: Sean Cody | last post by:
I'm trying to take a webpage that has a nxn table of entries (bus times) and convert it to a 2D array (list of lists). Initially this was simple but I need to be able to access whole 'columns' of data so the 2D array cannot be sparse but in the HTML file I'm parsing there can be sparse entries which are repsented in the table as &nbsp entities. The sparse output breaks my ability to use entire columns and have entries correspond properly....
0
2304
by: mb3242 | last post by:
Hello, I'm trying to use win32com to call a method in a COM object. I'm having a problem with Python choosing the wrong type when wrapping up lists into VARIANTs. The function I'm trying to call in C++ looks like this: HRESULT write( VARIANT * len, VARIANT * saData, VARIANT * result); Where saData contains a SafeArray of bytes and len is its length. The function returns any error information in result.
49
2985
by: Aidan | last post by:
I rely heavily on MSDN for documentation when it comes to HTML/DHTML/JavaScript/CSS but as a result I often have problems getting my stuff to work in Netscape/Mozilla/Firefox. I like the MSDN online documentation (http://msdn.microsoft.com/library/default.asp?url=/workshop/author/dhtml/re ference/objects.asp) because it has complete lists of DHTML objects, properties, methods, collections and event and for each element you can easily view...
385
17316
by: Xah Lee | last post by:
Jargons of Info Tech industry (A Love of Jargons) Xah Lee, 2002 Feb People in the computing field like to spur the use of spurious jargons. The less educated they are, the more they like extraneous jargons, such as in the Unix & Perl community. Unlike mathematicians, where in mathematics there are no fewer jargons but each and every one are
41
3964
by: Odd-R. | last post by:
I have to lists, A and B, that may, or may not be equal. If they are not identical, I want the output to be three new lists, X,Y and Z where X has all the elements that are in A, but not in B, and Y contains all the elements that are B but not in A. Z will then have the elements that are in both A and B. One way of doing this is of course to iterate throug the lists and compare each of the element, but is there a more efficient way? ...
0
246
by: Bikhod | last post by:
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>
11
9550
by: David Pradier | last post by:
Hi ! I've just inherited the responsibility of a postgresql database of roughly 480 tables and 6460 columns, mainly without constraints, not even foreign keys. I'd like to make it a little more orthodox (lots and lots of constraints, yeah !!), but I need a tool to make a documentation about every column, at least, as some column are really vicious (like, they are a foreign key to a table which depends on the type of another column...).
4
1236
by: Peter | last post by:
I found a minor error in the Python documentation for 2.4 which I thought I would report. But after a while I gave up. I wonder if this sort of reporting which is less than a bug could be made easier? The error was that the index entry to 'print statement' sent me to http://www.python.org/doc/2.4.2/lib/types.html#l2h-90. From the point of view of making Python accessible this sort of typo should be easily reportable.
1
2697
by: =?Utf-8?B?SmltIFdhbHNo?= | last post by:
I have an VC++ MFC Win32 application that isn't working correctly when I build it with VS2005. The problem seems to be in some ADO ActiveX controls that came with VS6 and are now out of support. So, I have decided to solve the problem by using a mixed assembly: Most of the program will be my MFC - based code (unmanaged), but I will implement one dialog box as managed code. In my original MFC app, this dialog box contains the problem ActiveX...
0
9646
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
9483
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
10346
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
1
10096
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
9956
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
8982
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
0
5386
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
0
5514
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
4055
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.