Summary is not appeared in the documentation using Sandcastle Help File Builder (SHFB)

Question

0.00/5 (No votes)

See more:

I have used Sandcastle for documentation of my C# desktop windows application. I am using Sandcastle Help File Builder (SHFB) and included *.sln or *.csproj file to extract the info and make it as a *chm documentation file. It compiled but didn't work properly as I have already added my comments like this

C#

/// <summary>
/// Create form to display the GUI to process the data of CPRI and XIO links in side the data grids.
/// </summary>

but it is not appear in the documentation(chm) file in FORM1 class and also in other classes. I have already included other summary in the similar manner in the other classes but it was also not include.Any idea?

I do n't know where I am lacking.....Thank you.

Posted 5-Aug-12 10:21am

skashanali

Updated 5-Aug-12 11:50am

Wes Aday

v2

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Wes Aday · Answer 1 · 2012-08-05T15:19:00

Solution 1

My guess would be that you did not enable the XML comments in your project settings. See this article[^] and see if that helps you.

Posted 5-Aug-12 15:19pm

Wes Aday

Comments

skashanali 6-Aug-12 6:05am

Thank you Wes, You made me think in another direction and then I got the solution.
By default in the "visibility" section, Document Private and Document Private fields are false and when I turn it on it worked for me.