Create custom section

Aug 10, 2010 at 4:07 PM

I'm looking for a way to document database tables used in classes/methods.

My idea is to create a custom section "Tables used" similar to "Members", "See also", etc.

Then, in the XML comments...

    /// <summary>
    /// My class info....
    /// </summary>
    /// <tables>
    /// Table1, Table2......
    /// </tables>

Is it possible?

Thanks!

Coordinator
Aug 10, 2010 at 8:31 PM

Yes, it is possible.  You'll need to add a template to the sandcastle transformation files (i.e. C:\Program Files\Sandcastle\Presentation\VS2005\main_sandcastle.xsl) to handle your custom tag.  See this blog post for information on how to do that:  http://blogs.msdn.com/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx.

Eric