HTML Help file does not include the enumeration field description

Topics: User Forum
Jul 8, 2010 at 7:03 PM
Edited Jul 8, 2010 at 7:04 PM

Hello,

I am using the last build of Sandcastle and SHFB to generate HTML help from C# (VS 2008). presentation style used is vs2005.

The file gets generated correctly but the enumerations are not including the summary tag in the description column of the Members grid. The member name column has the enum field name but the Description column is empty.

 

An example enum from my code:


    /// <summary>
    /// Calculation Effects supported by the system.
    /// </summary>
    [Serializable]
    public enum SystemCalculationEffect : int
    {
        /// <summary>
        /// No Effect.
        /// </summary>
        NoEffect = -1,
        /// <summary>
        /// Increase. The current amount will be added to the original amount.
        /// </summary>
        Increase = -2,
        /// <summary>
        /// Decrease. The current amount will be subtracted from the original amount.
        /// </summary>
        Decrease = -3,
    }

  

 Any help will be appreciated.

thanks,

lpi

 

Coordinator
Jul 8, 2010 at 8:06 PM

It's a bug in the Sandcastle transformations.  Download and apply the Sandcastle Styles patch.  It fixes that issue and several others.

Eric

 

Jul 8, 2010 at 8:24 PM

I will try it,

 

thanks,

 

lpi