Descriptions not showing up

Topics: General Discussion, General Questions
Oct 1, 2009 at 7:55 PM

Ok, I'm using Doc Project for the first time.  In my code I have all sorts of /// comments on classes, methods and variables.  When I compiled my doc project, it listed my classes, class variables, properties, and methods, but for all of them the "description" field is blank when I'm looking at the .chm file.  What do I need to do to get descriptions entered for all these items?

As a side note, when i list the methods in one of my classes, I see all my methods.  However, I also see a bunch of methods that don't appear in the code.  For example, my Utility class has one method "ConvertArrayListToTable".  The chm file lists that and "Equals", "Finalize", "GetHashCode", "GetType", "MemberwiseClone" and "ToStiring".  Can I get those extraneous methods that don't even show up in the class code to not show up in the documentation?

Oct 2, 2009 at 7:02 PM

Hi,

Did you enable XML documentation output for your project?  See the following article for more information.

http://docproject.codeplex.com/Wiki/View.aspx?title=Sandcastle%20Help#xmldoc

And here's a troubleshooting article for other common issues:

http://docproject.codeplex.com/Wiki/View.aspx?title=How%20to%20Diagnose%20and%20Resolve%20Issues 

- Dave

Oct 2, 2009 at 7:26 PM

Hi,

As for your second question, the members you are seeing in the documentation for your class are inherited from base types, such as System.Object.  You can tell Sandcastle to remove them by adding the Inheritance Filter to your DocProject or DocSite.  See the following article for more information (look for the section that contains the Inheritance Filter subsection).

http://docproject.codeplex.com/Wiki/View.aspx?title=How%20To%20Use%20The%20Topic%20Management%20Dialog#Saved

- Dave

Nov 10, 2011 at 4:28 AM

 If you use sandcastle help file builder (SHB)  to compile the chm file  then from the  SHB project property  set the DOCUMENT INHERITED FRAMEWORK MEMBERS (under visibility)  -  FALSE will exclude

"Equals", "Finalize", "GetHashCode", "GetType", "MemberwiseClone" and "ToStiring". from the compilation.

- Ravi