This project has moved and is read-only. For the latest updates, please go here.

summary and remarks not read?

Topics: User Forum
Jul 7, 2007 at 12:13 AM
Edited Jul 7, 2007 at 12:17 AM
I've just started trying to use Sandcastle (June 07 CTP, downloaded today) and the Help File Builder (, and I've got a problem.

I've added documentation (summaries, some remarks) to a set of classes. My build steps build the .xml file just fine, and it contains them.

But the .CHM I produce from the Help File Builder, while it includes the classes, does not seem to include the summary and remark text.

A search on "summary" and "remarks" in the help was not fruitful.

What am I missing?
Jul 7, 2007 at 3:03 AM
Are the methods in question public? If not, it won't include them unless you set the DocumentInternals and/or DocumentPrivates properties to true.

Jul 9, 2007 at 5:13 PM
The things in question are public interfaces, and also public properties in a public class, so I'm imagining that that's not it.

Any other possibilities?
Jul 9, 2007 at 8:50 PM
I can't think of anything off-hand. Can you reproduce it in a small example that you can send me along with the project file?

Jul 10, 2007 at 6:59 PM
Amazingly, for once, I can repro a problem in a small example, using an old test-bed project we had lying around.

If you can tell me how you want it sent (I don't see a way to attach to a discussion in any obivous way), it's about 200k of zip (source, project file, SHFB project, even the last attempt's output).
Jul 10, 2007 at 7:55 PM
You can e-mail it to me. My e-mail address is in the About box and in the footer of the pages in the help file.