merge local .net library documentation

Question

when I press F1 on some .net keyword it takes me to the help for that keyword. I have a .net library with its documentation. I am using this library.How can I get to the library help with F1 when I press F1 on some function from this library?

in general how can we merge the local documentation with the .net documentation?

score 2 · Answer 1 · edited May 23 '17 at 10:24

2

Are you sure you need that? The normal way is to provide contextual help for your libraries with intellisense, generating the xml files.

See this and this related entries.

Also:

What's the XML file that comes together with a .NET assembly file?

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

edited May 23 '17 at 10:24

Community

1
1

answered Jun 11 '12 at 19:37

leonbloy

73,180
20
142
190

The IntelliSense feature in Visual Studio only presents a small subset of the documentation which the XML file may include - basically limited to the `
` and `` tags. The F1 integration is used for displaying the extended information for any type/member in the .NET Framework, so for consistency it is nice to support your own SDK documentation in the same manner.
– Sam Harwell Aug 12 '13 at 12:47

score 0 · Answer 2 · answered May 21 '12 at 09:43

0

Unless that library provides Help 2/3 files, you won't be able to achieve that,

http://en.wikipedia.org/wiki/Microsoft_Help_2

http://en.wikipedia.org/wiki/Microsoft_Help_Viewer

answered May 21 '12 at 09:43

Lex Li

60,503
9
116
147

score 0 · Answer 3 · answered Jun 11 '12 at 19:57

Take a look at Sandcastle Help File Builder, which can generate a Help 1 (.chm) file, an MS Help 2 (.HxS) file, MS Help Viewer (.mshc), and/or a website.

The HTML Help 2.x output includes a valid set of collection files and an H2Reg.exe configuration file to simplify deployment and integration of the help file into existing collections such as those used by Visual Studio.

merge local .net library documentation

3 Answers3