XML comments not appearing in CHM file

Feb 6, 2008 at 5:14 PM
Edited Feb 6, 2008 at 5:15 PM
Hi all,

I'm new to Sandcastle and the Help File Builder. Versions I'm using:

Sandcastle Jan 2008 release
Help File Builder (v. 1.6.0.4)

I'm just trying something very simple to test things out and for some reason the XML comments are not appearing in the CHM file. From what I can tell (and have read), I'm not doing anything wrong but I may have missed something.

Here is my code:

''' <summary>
''' Gets the tombstone information for an applicant.
''' </summary>
''' <param name="FileNumber">test</param>
''' <remarks>test</remarks>
Public Sub GetApplicantTombstone(ByVal FileNumber As Integer)

End Sub

and here is the XML file that is generated:

<?xml version="1.0"?>
<doc>
<assembly>
<name>
camis
</name>
</assembly>
<members>
<member name="P:camis.clsApplicant.GivenName">
<summary>
Gets or sets the given name of the applicant.
</summary>
<value>Given name of the applicant.</value>
<returns></returns>
<remarks>The value must only contain characters.</remarks>
<database>PERSON.GIVEN_NAME</database>
</member><member name="M:camis.clsApplicant.GetApplicantTombstone(System.Int32)">
<summary>
Gets the tombstone information for an applicant.
</summary>
<param name="FileNumber">test</param>
<remarks>test</remarks>
</member>
</members>
</doc>

I then point SHFB to my assembly (and XML file) and then build. The CHM file appears fine with all of my classes, properties and methods, however, none of the XML comments are appearing.

I should also mention that when viewing the CHM, I'm assuming that when I select an item from the contents pane, the corresponding information should be displayed in the right content window, correct?

Any help would be greatly appreciated.

Thanks,
Randy
Feb 6, 2008 at 6:12 PM
Hi Randy,

For questions related to SHFB you may want to try the SHFB forums at http://www.codeplex.com/SHFB.


I should also mention that when viewing the CHM, I'm assuming that when I select an item from the contents pane, the corresponding information should be displayed in the right content window, correct?

Are you seeing something different? If you click an item in the table of contents (frame on the left), its topic should be displayed in the frame on the right.
Feb 11, 2008 at 2:35 PM
Actually, the only time I ever see anything in the frame on the right is when I first launch the CHM file, and it's an "Action Cancelled" message with the following error displayed: "Internet Explorer was unable to link to the Web page you requested. The page might be temporarily unavailable."

I've only commented the one property in my code though, just to see if things would work, so it makes sense that I'm not seeing much content in the frame on the right, but I would at least expect it to display the comemnts I've entered for the GetApplicantTombstone method.
Editor
Feb 11, 2008 at 4:29 PM
See my reply to you in the SHFB forum. It's probably a security patch that blocks content when viewed from a network share, etc.

Eric