sandcastle

问题 I am trying to add my own help file to Visual Studio 2010's Help Library by using WiX to run the HelpLibraryManagerLauncher that the Sandcastle Help File Builder creates after it builds my Sandcastle project. I am using WiX's QuietExec custom action to run the following command: HelpLibraryManagerLauncher.exe /product "VS" /version "100" /locale en-us /silent /brandingPackage Dev10.mshc /sourceMedia MyClassLibraryHelp.msha However, the MSI installer fails with the following: Action 00:00:00:

问题 I am using Sandcastles to generate a CHM help file for my project. I want a standalone CHM file that I can distribute, preferably on its own. The issue I have is that to embed images it appears that the image needs to exist on the user's system separately from the CHM file. When I view the source of my CHM file, it looks like: <img src="C:\Users\me\Pictures\wave.jpg" /> So if I email my CHM file to someone and they do not have this image, it will fail. An alternative would be to do: <img src=

问题 I need to convert my Sandcastle Help File Builder (SHFB) output that is a Web site (HTML) to Media wiki format Find a way to transfer/include the converted pages directly into the MediaWiki we have set up. Any ideas? we have over 1000 pages of HTML files inthe Website (output of SHFB). I thought of using a html2wiki converter ..I could think of looking around for a script to convert those 1000 pages into wiki format... that could take care of (1). But I would still be left with the block in

问题 Is it possible to include custom attributes in Sandcastle documentation? For example, consider this c# method: public void ExampleMethod ( [Required] string input1, [DefaultValue("example")] string input2 ) Is there any way to make Sandcastle documentation output that input1 has the required attribute? 回答1: This works for attributes and classes, I haven't tried it on properties and fields yet. The description suggests it should work. It might be required to turn on "Internal members" on too.

问题 In C# if I have a method that I add XML documenting, the following will be generated by default: /// <summary> /// Does something /// </summary> public string SomeValue { get; set; } I want to add my own doc-comment as follows below which is just fine in VS.NET build: /// <summary> /// /// </summary> /// <usage>Required</usage> public string SomeValue { get; set; } The problem is I do not see the new <usage> comment values displayed on my output .chm file. I'm pretty new to using Sandcastle

问题 I'm trying to take advantage of Sandcastle to help build out system documentation, but for some odd reason none of my <summary> data shows up in the chm ... has anyone had success w/ the latest build of Sandcastle and VS2008 using VB? 回答1: Have you checked to see that XML document generation is actually turned on (in Build properties) and is creating an XML file in the right place (i.e. bin/Release/)? Also, see this thread on MSDN, which documents the same problem I believe. 回答2: It is a 2

问题 I have a C# project with two namespaces in one solution. I've documented all the classes/functions/members/etc in both namespaces. As this project is a small research project, the namespaces are DocTestLibrary and DocTestLibrary.Events . However, when I try to create documentation from it via Sandcastle, it will only create documentation for the DocTestLibrary namespace. Is there any setting that I need to make in Sandcastle to make this work? I doubt it though, as I've scoured through most

问题 Closed . This question is opinion-based. It is not currently accepting answers. Want to improve this question? Update the question so it can be answered with facts and citations by editing this post. Closed last year . Consider that I have a complex class structure where many elements inherit from other elements. I may have a method GetStuff(string stuffName, int count) defined in an interface, which is inherited by other interface, which is then implemented abstractly by an abstract class,

问题 I'm very happy with the output from SandCastle, but I would also like to have some search functionality included in the HTML output, is this possible? 回答1: The Website output from SandCastle Help File Builder contains index.aspx and index.html . If you display index.html then you don't get the search or index options: http://www.ewoodruff.us/shfbdocs/index.html If you display index.aspx then you do get the search and index options: http://www.ewoodruff.us/shfbdocs/index.aspx 回答2: According

问题 I am trying to generate website documentation for my C# code using the NuGet package of Sandcastle in Visual Studio (EWSoftware.SHFB). The fact is that I don't know how to use it. I install it from the NuGet package manager and then I have no idea what to do with it. I have no problem to edit my documentation project and to generate the corresponding website using the VS Sandcaslte extension installed with the default installer. Thank you for your help. 回答1: Assuming that you already have a