<summary> tags not showing in output docs.

Aug 25, 2010 at 2:51 PM

Here is an overview of what I am using.

  • VS2010
  • .NET 4.0 (c#)
  • Sandcastle (latest release with Sandcastle Styles June 2010 patch applied)
  • Sandcastle Help File Builder (GUI)
    • Referencing the SLN file for the project, no other customizations.

My documentation is showing no description for any of my classes or methods.  Here is a code example:

/// <summary>
/// This class provides support for logging information, warning and error messages from an application.
/// </summary>
public static class Log
{
    /// <summary>
    /// Will log an unencrypted exception message.
    /// </summary>
    /// <param name="message">Message to log to the exception.</param>
    /// <returns>If exception was logged successfully.</returns>
    public static bool LogException(string message)
    {
        return LogException(message, false);
    }
}

Any help would be greatly appreciated.  This is a great tool BTW.

 

 

 

Editor
Aug 25, 2010 at 3:20 PM

See the walkthroughs in the Getting Started section of the SHFB help file to ensure that you've properly enabled XML comments in your Visual Studio project in each configuration (i.e. Debug and Release) and that they are being generated.  Make sure you've selected the appropriate Debug or Release configuration setting in the SHFB project too.

Eric

 

Aug 25, 2010 at 9:30 PM

Sometimes you think you have read enough... sometimes you realize you didn't even start reading.  Fixed.... thanks sir!