1
Vote

Presentation issue list-tag as child of param-tag

description

When a list-tag with type set to table is a child of a param-tag, the generated list is slightly bigger than the window of the CHM-viewer. As a result, an extra scrollbar is shown at the bottom of the viewer while this is not necessary. It is as if the width of the table is miscalculated by not taking the offset of the param tag into account.
 
The following code is an example of this:
 
/// <summary>
/// Testing Sandcastle.
/// </summary>
/// <param name="x">
/// <list type="table">
/// <item><term>1</term><description>2</description></item>
/// <item><term>2</term><description>3</description></item>
/// <item><term>3</term><description>4</description></item>
/// </list>
/// </param>
/// <returns>An integer.</returns>
public static int Test(int x)
{
  return x + 1;
}
 
Yves

comments

davedev wrote Feb 3, 2008 at 12:48 AM

I don't think it's common to see tables in the parameters section of MSDN documentation. You're probably better off adding the table in the remarks section. For one thing, Intellisense isn't going to use the table anyway so you're better off writing a simple one-line description of the parameter and possibly adding something like, "See the remarks section for more information.".