473,797 Members | 3,174 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Include tag doesn't work in documentation comments

I tried following the pattern in MSDN and it just plain doesn't work.

I replaced the comments for a class with an include tag but did not change
any of the comments on the members of the class (without the include tag my
docs were building fine).
/// <include file='Command2. xml' path='MyDocs/MyMembers[@name="class"]/*'/>
public class MyClass : ...

with Command2.xml looking like:
<MyDocs>
<MyMembers name="class">
<summary>
My description.
</summary>
</MyMembers>
</MyDocs>

and I get
Command2.xml: error CS1592: Badly formed XML in included comments file --
'System error: -2146697210.

What is going on? I'm using Visual Studio .NET 2003.

Thanks,
Philippe
Nov 16 '05 #1
2 1824
"Philippe Bertrand" <my*****@ianywh ere.com> wrote in
news:10******** *****@corp.supe rnews.com:
I tried following the pattern in MSDN and it just plain doesn't
work.

I replaced the comments for a class with an include tag but did
not change any of the comments on the members of the class
(without the include tag my docs were building fine).
/// <include file='Command2. xml'
path='MyDocs/MyMembers[@name="class"]/*'/>
public class MyClass : ...

with Command2.xml looking like:
<MyDocs>
<MyMembers name="class">
<summary>
My description.
</summary>
</MyMembers>
</MyDocs>

and I get
Command2.xml: error CS1592: Badly formed XML in included
comments file -- 'System error: -2146697210.

What is going on? I'm using Visual Studio .NET 2003.


Phillippe,

Is Command2.xml located in the same folder as your source code?
That's where I have my XML comment include files and it works OK for
me.

--
Hope this helps.

Chris.
-------------
C.R. Timmons Consulting, Inc.
http://www.crtimmonsinc.com/
Nov 16 '05 #2
That was the trick. My build process pre-processes .cspp into .cs resulting
in the .cs being in another directory. I made it copy the included doc tag
file to the same directory as the .cs file and it work.

Thanks for the help
Philippe

"Chris R. Timmons" <crtimmons@X_NO SPAM_Xcrtimmons inc.com> wrote in message
news:Xn******** *************** **********@207. 46.248.16...
"Philippe Bertrand" <my*****@ianywh ere.com> wrote in
news:10******** *****@corp.supe rnews.com:
I tried following the pattern in MSDN and it just plain doesn't
work.

I replaced the comments for a class with an include tag but did
not change any of the comments on the members of the class
(without the include tag my docs were building fine).
/// <include file='Command2. xml'
path='MyDocs/MyMembers[@name="class"]/*'/>
public class MyClass : ...

with Command2.xml looking like:
<MyDocs>
<MyMembers name="class">
<summary>
My description.
</summary>
</MyMembers>
</MyDocs>

and I get
Command2.xml: error CS1592: Badly formed XML in included
comments file -- 'System error: -2146697210.

What is going on? I'm using Visual Studio .NET 2003.


Phillippe,

Is Command2.xml located in the same folder as your source code?
That's where I have my XML comment include files and it works OK for
me.

--
Hope this helps.

Chris.
-------------
C.R. Timmons Consulting, Inc.
http://www.crtimmonsinc.com/

Nov 16 '05 #3

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

Similar topics

17
2265
by: Bart Nessux | last post by:
How can one view the contents of a queue? I'd like to verify that the queue has the same number of objects as the list that has been put into it. Also, should one think of a queue as static or dynamic (on the put side)? Do you put stuff in it once and then get from it until it's empty or do you put stuff in it a bit at a time? Or, can you do both? Also, does the queue actually get smaller as the threads feed from it or does it stay the...
3
2806
by: Nathan Wallace | last post by:
Hello, I have 2 schema, for argument sake let's call them child.xsd and parent.xsd. I define all my types in parent.xsd and the child.xsd include the parent.xsd using the following tag: <xs:include schemaLocation="http://localhost/xsds/parent.xsd"/> Now when I create an XmlSchema object on the child.xsd I couldn't get the type that I define in the parent.xsd. How do I get this? Do I need to create
3
2168
by: Jesper Odgaard | last post by:
Hi, When documenting my code using comment web pages from the visual studio .Net 2002 ide, it seems that it ignores the <example> tag. Except for this tag everything works fine. Can I customize the web pages to include examples? brgds Jesper. /// <summary>
1
3313
by: Alex VanderWoude | last post by:
I am trying to <include> some text into an XML documentation topic, but that text is stored in a file that is in a different directory than the "current" XML file. Using a relative path does not appear to work, because the base being used is the Common7\IDE directory, not my original source directory. Here is the situation: MyApp directory contains the file Form1.cs, Form1.xml, and Generic.xml. There is also a subdirectory called...
14
1616
by: Don Wash | last post by:
Hi There! In C# you can use /// to add comments that can produce XML documentation. What about in VB???? Thanks, Don
5
1498
by: WStoreyII | last post by:
Is there some sort of a preset way for compiling documetation about an assembly or a project. The Reason that i ask this is that sometimes when i look at examples for code i see things like this. <summary>This is a summary</summary> public function test() end function and then this is the same stuff that i will see in the documentation. if this is the case how do i set this up or compile it?
40
2806
by: GTi | last post by:
Is there any source code documentation tools available for Visual Studio 2005 ? I have created a LIB that must be documented. Must I do it by hand or is it some kind of tools to pre document my source code?
5
8558
by: Bob Altman | last post by:
I thought I read somewhere in the MS documentation that XML documentation is compiled in C++, but the C++ code editor obviously doesn't do anything interesting when I enter "///". What's the deal with C++ and XML docs? Is there an add-in available to help with entering XML docs? TIA - Bob
0
1144
by: Gennaro Prota | last post by:
Hi, after several "tweaks" I think I've finally found a file layout which I like for my code (in terms of where the copyright line and the license reference go, where the vim modeline etc.). For included files, I've stuck so far to the suggestion in C++ Coding Standards which says: Don't try to be clever: Don't put any code or comments before and after the guarded portion, and stick to the standard form
0
9685
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
9536
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
10468
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
10205
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
9063
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...
1
7559
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
6802
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
5582
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
3
2933
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.