473,387 Members | 1,529 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,387 software developers and data experts.

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 1796
"Philippe Bertrand" <my*****@ianywhere.com> wrote in
news:10*************@corp.supernews.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_NOSPAM_Xcrtimmonsinc.com> wrote in message
news:Xn*********************************@207.46.24 8.16...
"Philippe Bertrand" <my*****@ianywhere.com> wrote in
news:10*************@corp.supernews.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
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...
3
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: ...
3
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...
1
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...
14
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
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....
40
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...
5
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...
0
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...
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
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,...
0
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...
0
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,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...

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.