Accessing xml help in 3rd party lib..??
-
I'm new to xml docs, and I'm trying to use a third party .NET lib that came with an xml doc file... would like to be able to access the help but can't find info on how to do this... I've added the project to my solution, and I've verified that the xml file exists in the location specified by the projects output dir... built the solution but nothing appears in dynamic help for the project/lib... What am I doing wrong..??? thanks for any help.. vince .
-
I'm new to xml docs, and I'm trying to use a third party .NET lib that came with an xml doc file... would like to be able to access the help but can't find info on how to do this... I've added the project to my solution, and I've verified that the xml file exists in the location specified by the projects output dir... built the solution but nothing appears in dynamic help for the project/lib... What am I doing wrong..??? thanks for any help.. vince .
The XML documentation generated by the compiler must be parsed by tools such as NDoc (which I help develop). To integrate the help into VS.NET, you actually have to do quite a bit of work that involves the Help 2 system. You can find more information on MSDN by searching for "VSHIK", the Visual Studio Help Integration Kit. As far as "tooltip help" when you're typing in the VS.NET source window, the XML file for the assembly merely has to be in the same directory as the assembly itself. VS.NET will see that XML file and show the appropriate help based on what you're typing (class, method, parameter, property, etc.). It will not automatically integrate this into the help system (dynamic help, table of contents, index, and search), however.
-----BEGIN GEEK CODE BLOCK----- Version: 3.21 GCS/G/MU d- s: a- C++++ UL@ P++(+++) L+(--) E--- W+++ N++ o+ K? w++++ O- M(+) V? PS-- PE Y++ PGP++ t++@ 5 X+++ R+@ tv+ b(-)>b++ DI++++ D+ G e++>+++ h---* r+++ y+++ -----END GEEK CODE BLOCK-----