sandcastle

How to localize the documentation of a .NET library [closed]

by

One strategy, which would require some coordination with the Sandcastle XSLT files, would be to use the xml:lang attribute on your XML documentation. Visual Studio 2010 allows multiple tags to remain (although you may get complaints about duplicate tags). /// <summary> /// Gets or sets the fill size of the load operation. /// </summary> /// … Read more

What rules are applied to SHFB’s IntelliSenseComponent’s output folder?

by

My experiments showed that SHFB’s IntelliSenseComponent did treat {@OutputFolder} correctly, but there’s a nuance. If the folder attribute specified in <output includeNamespaces=”false” namespacesFile=”Namespaces” folder=”…” /> points to a folder inside a project’s OutputPath folder (.\docs\api in your case) then SHFB’s build process creates the folder, but then deletes it before generating website contents: Last step … Read more

How can I find out what’s causing differences in generated Sandcastle docs?

by

A couple of ideas considering your recent edits, although I agree it is a bit shooting in the dark… I would use a tool like “Beyond Compare” to compare the .Net Framework files and XML files on both machines (“folder compare” profile). Favour the binary level comparison to be perfectly sure… if both of your … Read more

Namespace documentation on a .Net project (Sandcastle)?

by

Sandcastle also supports the ndoc-style namespace documentation, which allows you to stick the documentation in the source files: Simply create a non-public class called NamespaceDoc in the namespace you want to document, and the xml doc comment for that class will be used for the namespace. Adorn it with a [CompilerGenerated] attribute to prevent the … Read more

Is it possible to merge two pages created by SandCastle into a single main page?

by

I can’t provide a working answer for this, but I can offer some ideas that may work if someone is willing to hack around with it: 1. The config htmlBody.xsl defines some of the structure including a section with a test for members: <xsl:if test=”$subgroup=’members'”> If this was turned on at the class level (or … Read more

tech