spinnaker15136

I wrote a class assembly and used the wonderful Sandcastle for documentation. When I am in VB and place the cursor over a keyword from my assembly, the help system is not finding my help file. How can I make VB, V# etc. find my help file



Re: Developer Documentation and Help System How does Visual Studios find the help file for my class assembly?

Paul ORear MSFT

Hello Spinnaker15136, I have a few questions that will help me to best answer your question:

1) Have you verified that your content is otherwise showing up in the VS Help system i.e. can you get to your topics via the TOC, Index or Search
2) When you say that the help system is not finding your help file, are you looking in the Dynamic Help pane, or are you looking for Intellisense type of help - like the function syntax and summary

Thanks!






Re: Developer Documentation and Help System How does Visual Studios find the help file for my class assembly?

spinnaker15136

Normal VS Help is showing up just fine.

Are you saying the help file I created will show up in the index too

It is not doing that. How do I get it to do that Just put it in a special directory





Re: Developer Documentation and Help System How does Visual Studios find the help file for my class assembly?

Paul ORear MSFT

No, the VS Help system is fairly complex and requires that you would register your content via an installer in order for it to be integrated with the rest of the help content. Have you downloaded the VS SDK If not, you can download it from here:

Microsoft Visual Studio 2005 SDK version 3.0

The online help that is part of this SDK documents how to integrate help content with Visual Studio. The SDK also includes a Help Integration Wizard which you can use with content that you generate with Sandcastle (.hxs files) to create a package to integrate with Visual Studio.