File Header to Help Documentation

Topics: Developer Forum, User Forum
May 30, 2008 at 6:14 PM
First of all, let me congratulate you for the great job you are doing with sandcastle help file builder.

My question is about header files and how can I retrieve it (if I want to) to the sandcastle generated help file.

For example, if I had a header in the file like this (or it can be another type), or something else, how can I put it to the help file?

/// -----------------------------------------------------------------------
/// <copyright file="nameofthefile.cs" company="companyname">
/// <UserName>createdfileusername</UserName>
/// <CreationDate>creationfiledate</CreationDate>
/// <Description>
/// [describe your unit here]
/// </Description>
/// </copyright>
/// -----------------------------------------------------------------------


Thanks for everything,

Ricardo Faustino

Coordinator
May 31, 2008 at 1:19 AM
Comments are associated with a namespace, type, or member.  As such, you'd have to put them on a type or class member.  Namespaces don't support XML comments directly but SHFB will pick them up if placed in the project's Namespace Comments or if they are placed on a NamespaceDoc class within the namespace (see the help file for info).  Once included though, you'd have to modify the Sandcastle transformations to utilize the comment tags as they are custom and do not currently get processed.  There's a blog about how to add custom templates.  I can track it down if you want to pursue it further.

Eric