XML documentation on an interface

[Karsten Schramm]

Hi I wrote an interface and a class which implements this interface.

I documented the interface methods of the interface.
In a third class I tried the following

IInterface myIntf = new CClass(); //CClass implements IIinterface
if I now press
myIntf.DoSomething

I expected a tooltiptext whith the <summary> of the interface method.
Unfortunately it shows nothing but the name, parameters and return
value.

Why?

[Karsten Schramm]

PS: This effect occurs, if the interface is in another assembly then
the interface implementing class

[Nicholas Paldino [.NET/C# MVP]]

Karsten,

If the interface is in another assembly, then did you generate the XML
documentation for that assmbly? You need to have the /doc switch (for
command line builds) set, or the setting in the project properties set to
generate the XML documentation (look at the project properties). Once you
built it, you need to name the file the same name as the assembly, but with
an XML extension.

If you have done all of this, you then make sure that this file is in
the same directory as the assembly is (which you have a reference to), and
then you should see the documentation.

Hope this helps.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard.caspershouse.com

"Karsten Schramm" <Ne**********************@yajirobi.de> wrote in message
news:11**********************@g47g2000cwa.googlegr oups.com...

PS: This effect occurs, if the interface is in another assembly then
the interface implementing class

[Karsten Schramm]

Yeah thanks, it works. But only if the reference is on "local copy =
true". Is that correct?

[Nicholas Paldino [.NET/C# MVP]]

Karsten,

Either way, the XML documentation file has to be in the directory that
the assembly is in that the reference is set to. Setting local copy = true
means that the assembly is copied to the output directory when it is
compiled, and shouldn't affect the search for the XML documentation file.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard.caspershouse.com

"Karsten Schramm" <Ne**********************@yajirobi.de> wrote in message
news:11**********************@g49g2000cwa.googlegr oups.com...

Yeah thanks, it works. But only if the reference is on "local copy =
true". Is that correct?

[Karsten Schramm]

Nicholas Paldino [.NET/C# MVP] schrieb:

Karsten,

Either way, the XML documentation file has to be in the directory that
the assembly is in that the reference is set to. Setting local copy = true
means that the assembly is copied to the output directory when it is
compiled, and shouldn't affect the search for the XML documentation file.

Yeah, but it does. I tried it in a mini project.

Please download and build

http://doena-soft.de/upload/TestXMLD...Copy_False.rar

http://doena-soft.de/upload/TestXMLD...lCopy_True.rar

After build I cannot see the documention if localcopy = false

[Karsten Schramm]

sorry, I meant

http://doena-soft.de/upload/TestXMLD...Copy_False.zip

[Karsten Schramm]

Karsten Schramm schrieb:

http://doena-soft.de/upload/TestXMLD...Copy_False.rar

http://doena-soft.de/upload/TestXMLD...lCopy_True.rar

Sorry, I meant

http://doena-soft.de/upload/TestXMLD...Copy_False.zip

http://doena-soft.de/upload/TestXMLD...lCopy_True.zip