473,322 Members | 1,846 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,322 software developers and data experts.

XML documentation file name

Hi all,

I have a VS 2005 SP1 Visual Basic solution that creates a bunch of
assemblies (both main programs and DLLs). All of the projects have
"Generate XML documentation file" selected on the Compile tab of the My
Project designer. Now here's the weird part that I need help with: 2 of
the 8 projects generate XML documentation in a file whose name is identical
to the assembly name (plus a .XML extension) as expected. The other 6
generate XML documentation in files whose name does not match the assembly
name. When I reference one of those 6 assemblies from another solution, I
don't get intellisense because VS doesn't find a matching .XML file.

How does VS decide on a name to give to the XML documentation file that it
creates? Is there some setting somewhere that I'm not stumbling across?

TIA - Bob
Mar 21 '07 #1
3 1829
Hi Bob,

MSDN document on VB.NET Project Designer says "The Generate XML document
file property is set on the Compile page of the Project Designer. When this
option is selected, XML documentation is automatically emitted into an XML
file, which will have the same as your project and the .xml extension."

The MSDN document doesn't mention there's a setting for the name of the XML
document to be generated in VB.NET projects. I tried to find in the options
window(Tools|Options), and didn't find a setting for the name of the XML
document for VB.NET projects, either.

What application types are the projects in your solution, whose own XML
document's name is incorrect, Windows Application, Class Library or
something else?

In fact, when we select the 'Generate XML document file' option in the
Compile page of the Project Designer and then save the changes, the name of
the XML document to be generated is saved to the project file. Navigate to
the project file(.vbproj) in Windows Explorer and open the project file
with Notepad. You should see the name of the XML document in the
<DocumentationFiletag within the <PropertyGrouptag.

I think a workaround to your problem is to modifty the name of the XML
document in the project file with Notepad manually, and then build the
project.

Hope this helps.
If you have anything unclear, please feel free to let me know.
Sincerely,
Linda Liu
Microsoft Online Community Support

==================================================
Get notification to my posts through email? Please refer to
http://msdn.microsoft.com/subscripti...ult.aspx#notif
ications.

Note: The MSDN Managed Newsgroup support offering is for non-urgent issues
where an initial response from the community or a Microsoft Support
Engineer within 1 business day is acceptable. Please note that each follow
up response may take approximately 2 business days as the support
professional working with you may need further investigation to reach the
most efficient resolution. The offering is not appropriate for situations
that require urgent, real-time or phone-based interactions or complex
project analysis and dump analysis issues. Issues of this nature are best
handled working with a dedicated Microsoft Support Engineer by contacting
Microsoft Customer Support Services (CSS) at
http://msdn.microsoft.com/subscripti...t/default.aspx.
==================================================

This posting is provided "AS IS" with no warranties, and confers no rights.

Mar 22 '07 #2
"Linda Liu [MSFT]" <v-****@online.microsoft.comwrote in message
news:Rl**************@TK2MSFTNGHUB02.phx.gbl...
I think a workaround to your problem is to modifty the name of the XML
document in the project file with Notepad manually, and then build the
project.
Thanks Linda. I manually fixed the vbproj files and now everything works as
it should.
MSDN document on VB.NET Project Designer says "The Generate XML document
file property is set on the Compile page of the Project Designer. When
this
option is selected, XML documentation is automatically emitted into an XML
file, which will have the same as your project and the .xml extension."
Actually, the desired behavior seems to be that the xml file must have the
same name as the assembly (which may not match the project name).
The MSDN document doesn't mention there's a setting for the name of the
XML
document to be generated in VB.NET projects. I tried to find in the
options
window(Tools|Options), and didn't find a setting for the name of the XML
document for VB.NET projects, either.
I guess I could have tried changing the assembly names in the My Project
designer (to "xxx" and then back to their proper names) to see if something
in the designer magically changes the documentation file to match, but that
didn't occur to me until after I had changed the vbproj files.
Mar 22 '07 #3
Hi Bob,

Thank you for your feedback.
Actually, the desired behavior seems to be that the xml file must have
the
same name as the assembly (which may not match the project name).

I performed a test on this and did see the name fo the xml file has the
same name as the assembly, not the project. Thank you for pointing it out :
)

I am sorry that I am not sure what causes the problem that the xml file's
name doesn't match the assembly name in your project, unless you modify the
vbproj file with Notepad manually. But at least, we have a workaround for
this problem.

If you have any other question in the future, please don't hesitate to
contact us. It's always our pleasure to be of assistance!

Have a nice weekend!

Sincerely,
Linda Liu
Microsoft Online Community Support

Mar 23 '07 #4

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

Similar topics

5
by: AA | last post by:
Hello, I was commented my class and copile it, when the compilation finished th VS create the XML document It is cool because I can use to generate MSHelp documentation but, when I import my...
8
by: Will Pittenger | last post by:
I have a Windows program C# .NET solution where when I update its XML documentation, some tags are not recognized and turned into the corresponding HTML. Those tags include <c>, <code>, <para>,...
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: WALDO | last post by:
Where can I find some documentation on creating XML comment files. I would like to know the format/conventions for creating them.
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....
2
by: R.A.M. | last post by:
Hello, I am learning .NET 2.0. I need to learn how to create documentation from /// comments. I downloaded sample project XMLsample from Web and I generated XML documentation XMLsample.xml: ...
3
by: Noman Ali | last post by:
Hi, It seems that ASP .NET 2.0 does not support XML documentation feature. Is there any way to do this? I serached alot and only find this solution but it didnot works for C#. Here it is. ...
2
by: bthubbard | last post by:
This may not be the best group in which to post this. If there is a better location please direct me there. I have been experimenting with Sandcastle to generate CHM help file documentation for...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 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 former...

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.