Stack Overflow
Stack Overflow

Questions tagged [sandcastle]

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments.

Originally developed by Microsoft, Sandcastle has the following key features:

  • Works with or without authored comments
  • Supports Generics and .NET

The original project is inactive, but new development continues at http://shfb.codeplex.com/

298 questions
0
votes
1 answer

how to link to an external file in sandcastle

I am using sandcastle and I have an external file that I want to provide a link to with a relative path. I have found an example that uses javascript to accomplish this, but the example doesn't work for me and I can't find any other way to setup a…
BotHead
  • 171
  • 1
  • 5
0
votes
1 answer

Deploying api documentation from .chm files

I am currently working on documenting our now massive code base. I can use sandcastle to generate .chm files that contain the xml comments I have inserted into the code. My question now I guess is: What next? I would like to be able to host them on…
mac
  • 294
  • 1
  • 5
  • 22
0
votes
3 answers

Unobstructive XML commenting

I've created a project and started work on documenting it. Sandcastle uses XML comments to create a nice help file, but the XML comments leave the code nearly unreadable. Each class I write now starts off something like this: /// ///…
Lukas Bystricky
  • 1,152
  • 5
  • 13
  • 33
0
votes
1 answer

how reference member comment in Sandcastle

Code sample : // // look // public class Class1 { } public class Class2 { //do something ... public void DoSomething(object obj) { ... } } I need Class1 "remarks"…
user2164641
  • 69
  • 8
0
votes
1 answer

SandCastle generate doc. from website

I am trying to generate documentation for a WebSite, but, I don't have a project, in other words, I just go in Visual Studio and I Open a WebSite, I can't generate the XML documentation from this web project style: And, I see in that documentation…
Alexandre
  • 1,805
  • 1
  • 26
  • 52
0
votes
2 answers

Simplest way to add XML doc to a WinRT project

We have a group of developers moving from C++ to C# and WinRT. We used D'Oxygen as part of our C++ developer builds, and I'd like to continue to have document generation as part of the developer build in C#/WinRT. It's easy to turn on XML Doc…
Scott Smith
  • 3,401
  • 2
  • 28
  • 57
0
votes
1 answer

Sandcastle Help File Builder: HTML not being generated from MAML

I have added a test.aml file to my Sandcastle project with a BuildAction of None. I've also added a Content Layout.content file and added test.aml to the layout. When I build the help (website format only) the topic is included in the TOC but the…
Antony Scott
  • 20,775
  • 10
  • 60
  • 88
0
votes
1 answer

Include common content from xml documentation file

I am using Sandcastle to generate documentation for a project. In order to reference xml documentation file include tag is used. /// public class Test And I would like…
k0stya
  • 4,091
  • 29
  • 39
0
votes
1 answer

Documentation of Application settings with SHFB

I am trying to document the settings of my application in a Windows help file using Sandcastle Help File Builder. I have documented the settings in Visual Studio using Settings - Properties-Definition. I can see inside the generated…
weismat
  • 6,743
  • 3
  • 38
  • 55
0
votes
1 answer

Can sandcastle read XmlDoc from an external file instead of header comments?

Sandcastle Help File Builder (SHFB) turns triple slash comments into documtation like so: ///A class called Bob public sealed class Bob {} The schema for the documentation is very robust. However, the more robust and verbose…
Justin Dearing
  • 12,753
  • 19
  • 80
  • 146
0
votes
1 answer

Sandcastle 2.7 - What installer is it using?

Having just downloaded and installed the latest version of Sandcastle I was impressed with the installation process. Does anyone know what was used to make the installer? http://sandcastlestyles.codeplex.com/releases/view/86091 In particular, points…
paligap
  • 892
  • 1
  • 12
  • 28
0
votes
2 answers

Sandcastle & SHFB, hide fields from TOC?

I'm currently documenting a WCF service and need to strip the TOC to a bare minimum. Is it possible to exclude fields sub topic from a class' TOC? Thanks in advance.
jaspernygaard
  • 2,852
  • 4
  • 31
  • 47
-1
votes
2 answers

Sandcastle not generating params or return

I have a Visual Studio C# project with XML documentation comments. I get a .xml file with , , and members. The text I put inbetween the tags is shown in the help file as well as Namespace, Assembly,…
Simon
  • 85
  • 6
1 2 3
…
19
20