XML Documentation File

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

Edward Diener - 10 Dec 2004 12:14 GMT

I specify. for my XML documentation setting under project properties, a path
that is relative to my project directory, such as "doc/myxml.xml". When I
build the project, the IDE does generate the xml documentation file there.
It also generates the same xml documentation file in my output directory.
Why does it do the latter ? I only want and need a single copy of the xml
documentation file. Is there any way to shortcut this second, duplicate
generation of the file, or is this just an irritational bug in the IDE ?

Reply to this Message

Carlos J. Quintero [.NET MVP] - 10 Dec 2004 13:29 GMT

I suppose it is "by design". Should your assembly be referenced in another
project, the IDE would use the xml in the same folder of the assembly to
provide tooltips, help text, etc. for Intellisense.

If deleting it is so important you can either use a post-build command line
(C# Project Properties, Common Properties, Build events) or make a simple
add-in to trap the build event and delete the file.

Signature

Carlos J. Quintero

The MZ-Tools all-in-one add-in, now for .NET: http://www.mztools.com

>I specify. for my XML documentation setting under project properties, a
>path that is relative to my project directory, such as "doc/myxml.xml".
[quoted text clipped - 4 lines]
>duplicate generation of the file, or is this just an irritational bug in
>the IDE ?

Reply to this Message

Edward Diener - 10 Dec 2004 13:52 GMT

>I suppose it is "by design". Should your assembly be referenced in another
>project, the IDE would use the xml in the same folder of the assembly to
>provide tooltips, help text, etc. for Intellisense.

OK, that makes sense. Rather than try to change the relative directory, I
have decided to just give a filename rather than a relative-path/filename
and let the IDE just put it in the output directory.

> If deleting it is so important you can either use a post-build command
> line (C# Project Properties, Common Properties, Build events) or make a
[quoted text clipped - 8 lines]
>>duplicate generation of the file, or is this just an irritational bug in
>>the IDE ?

Reply to this Message

XML Documentation File

Free Magazines