Sandcastle doesn't output everything from a F# assembly

余生长醉 提交于 2020-01-14 14:28:29
问题 It only recognizes top-level non-function value declarations. e.g. let a = 2 and doesn't produce documentation for functions or type definitions. I've checked the xml documentation file and it has all the /// comments I put in the source, but none of them (except for the top level values) show up in the resulting html. 回答1: Yes, using C#-centric tools for F# documentation generation is usually pretty horrible. We started an alternative project a while ago, but it is not yet as mature as

Can I programmatically export class diagrams from Visual Studio 2008?

落爺英雄遲暮 提交于 2020-01-04 09:18:32
问题 I can export a class diagram as an image from Visual Studio by right-clicking on the surface and choosing "Export Diagram as Image..." Is there a way to do this through command line? I'd like to be able to generate all of my class diagrams as images so I can include it in the .chm I am building w/ Sandcastle. 回答1: Found it after a full day of searching. In case anyone ever comes across this again: Two ways to do this: Microsoft.VisualStudio.Modeling.Diagrams.Diagram.CreateBitmap() lets you

What's the syntax to inherit documentation from another indexer?

天涯浪子 提交于 2020-01-04 05:40:49
问题 In my implementation I have this: /// <inheritdoc cref="IInterface{T} this[,]"/> public T this[long row, long column] { ... } The XMLdoc is already present in the IInterface . How can I pick it up from there (like I do for other things)? I get a compiler warning: Warning 108 XML comment on 'XXX.YYY.this[long, long]' has syntactically incorrect cref attribute 'IInterface this[,]' I tried removing the this from the cref but that didn't work either. What syntax do I need? 回答1: Use this: cref=

Generate HTML / Help files from VS 2010 C# XML documentation

南楼画角 提交于 2019-12-30 01:38:27
问题 I am looking for a good tool creating HTML / Help files from my VS2010 XML documentation. I have found some commercial tools, such as .Net documentation tool VSDocman I am sure there are more, I just list these two as examples. Also there are simple XSLT stylesheets around to convert the XML to HTML documentation. What are you using, e.g. is there a free tool to do the conversion, maybe as Add-In. Just to clarify, basically I have found two types of tools: The ones converting the XML

How to get Sandcastle to include inherited properties

核能气质少年 提交于 2019-12-24 17:14:38
问题 I have 2 POCO classes for my view model: public class BaseView { public int Id { get; set; } public string Name { get; set; } } and public class FullView : BaseView { public string Reference { get; set; } public bool IsActive { get; set; } } When I generate a CHM help file using Sandcastle (2014.5.31.0) both are included but the FullView only shows it's 2 properties. How can I get it to include the BaseView properties that it is inheriting? 回答1: Right click the Sandcastle project > Properties

Hide methods inherited from Object from Sandcastle-generated documentation?

筅森魡賤 提交于 2019-12-24 14:28:28
问题 How can I hide methods that are inherited from the Object class (such as Equals, Finalize, GetHashCode, GetType, etc...) from Sandcastle-generated documentation. I have a class called LicenseManager that has a single method, and the Object inherited methods are clogging the display. I am using the latest version of Sandcastle + Sandcastle Help File Builder. 回答1: Found an option in "Sandcastle Help File Builder" that does this. Set

Installing Help with Help Library Manager and WiX

烈酒焚心 提交于 2019-12-24 01:49:15
问题 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:

Embedding images in CHM help file with Sandcastles

爷,独闯天下 提交于 2019-12-23 09:10:02
问题 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=

Convert Sandcastle Help File Builder Output (Web site) to MediaWiki format

北慕城南 提交于 2019-12-23 09:01:50
问题 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?

丶灬走出姿态 提交于 2019-12-22 06:48:55
问题 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.