Stack Overflow
Stack Overflow

Questions tagged [shfb]

Sandcastle Helpfile Builder

A GUI used to generate help files using Sandcastle.

Homepage: http://shfb.codeplex.com/

39 questions
2
votes
1 answer

How do I get Code Examples to show in the Help file using Sandcastle Help File Builder?

I'm using Sandcastle Help File Builder GUI and I can't seem to get code examples in my comments to appear in the help file output. I'm generating Help 1.x and MSDN-style HTML documentation. The examples look like the following in my code: ///…
DLauer
  • 1,272
  • 1
  • 15
  • 24
1
vote
1 answer

Mysteriously failing sandcastle build only when built by TeamCity

I have a rather large solution, which contains two documentation projects based on Sandcastle + Sandcastle Help File Builder (SHFB). These projects both build correctly from the command line (msbuild project.shfb) and also using the beta version of…
Tim Long
  • 13,000
  • 18
  • 75
  • 141
1
vote
2 answers

How to remove internal interfaces from class help page generated with Sandcastle or SHFB?

I have a class that implements many internal interfaces and I would like that documentation reader cannot see that class implements all those internal interfaces because this information is irrelevant for the readers. For example, if I have the…
GemBox Dev Team
  • 638
  • 5
  • 16
1
vote
1 answer

Sandcastle Authoring for Conceptual Topics

I'm working on writing some conceptual documentation to our otherwise technical documentation that is being produced in Sandcastle. There aren't a whole lot of good examples/links out there, but I'm starting to get the hang of MAML. If anyone has…
Locke
  • 966
  • 9
  • 28
1
vote
2 answers

Is there any way to import an external project or topic files in SHFB?

I want to produce a number of separate output CHM files (for separate libraries, so I have a separate shfbproj for each), but that have a number of conceptual topics in common. I would like to be able to put the .aml files for these topics in one…
Miral
  • 11,743
  • 2
  • 44
  • 89
1
vote
0 answers

Sandcastle Unresolved Assembly Reference

I am trying to use Sandcastle Help File Builder to take the XML from my methods and create documentation for my project. I have the XML and the DLL added as Documentation Sources and have configured the Wildcard Assembly References plugin to add my…
Andrew
  • 1,091
  • 1
  • 17
  • 26
1
vote
0 answers

Links to other terms within a term definition in Sandcastle

I'm composing a glossary using MAML. For example: BasicCommercialPack It's a set of
Matías Fidemraizer
  • 59,064
  • 16
  • 107
  • 181
1
vote
1 answer

SHFB Conceptual topic to include other HTML content in documentation project

In my Sandcastle Help File Builder project I have an HTML folder under the Content folder. It only contains HTML files! None are type of .AML (Application Markup Language File). How do I get these files to show up after compiling my SHFB…
JWP
  • 5,969
  • 3
  • 39
  • 65
1
vote
0 answers

List all classes tagged with a specific (custom) tag in a sandcastle documentation

Is there a way to create a list of all classes tagged with a specific (custom) tag in a Sandcastle documentation? I'm using a custom tag to mark specific behavior in my classes. I mapped this tag in main_conceptual.xsl and the content is shown at…
Micha
  • 11
  • 2
1
vote
0 answers

AjaxDoc - how to configure?

i want to document my project. Everything is working fine, but i cant get AjaxDoc working. Please, could somebody write me some short tutorial how to use them? I have SHFB integrated in Visual studio. Then i downloaded the WebApp project from…
prespic
  • 1,439
  • 1
  • 15
  • 20
1
vote
1 answer

Including a PDF file in SHFB generated .chm (Html Helpfile 1)

I need to include a pdf file in my sandcastle documentation. The user should be able to navigate to the pdf on clicking it in the .chm file. Is it possible to do this? I've been searching all forums with no proper answer. I have tried using href…
Pramod Shandilya
  • 11
  • 3
1
vote
1 answer

SHFB - problems with umlauts in .NET xml files

We are creating documentation for out .NET projects using Sandcastle and SHFB. Basically, this works. Unfortunately we are using .NET with a German language pack (and this shall stay this way ;-)), but apparently SHFB has a problem when loading…
Golo Roden
  • 112,924
  • 78
  • 260
  • 376
0
votes
1 answer

Filter content of inherited param comments

I have comments like this: /// some summary /// /// Comment 0 /// Comment 1 /// Comment 2 /// /// ///
tm1
  • 995
  • 10
  • 27
0
votes
1 answer

SandCastle Help File Builder and MAML, how to have an ordered list with a different starting index?

I'm using SandCastle Help File Builder 1.8.0.1 with its MAML content editor. I want an ordered list starting from a value other than the default of 1. 10. Some data 11. Other data I even tried the following and it does not work as it is from HTML…
Stécy
  • 10,711
  • 16
  • 60
  • 87
0
votes
0 answers

Unexpected error detected in last build step (sfml.net 2.5, doc/sfml.shfbproj)

I've downloaded sfml.net 2.5 and encountered a problem with compile ../doc/sfml.shfdproj into the chm file. Error decription is Unexpected error detected in last build step. I read build log and found problem with doc/Working/reflection.xml, but I…
TTaykAH
  • 35
  • 5
1
2
3