So I'm generating a documentation website using Sandcastle Help File Builder. Everything is generated great! However, when looking at a page for a class, I'd like for the Properties table (which currently has the icon, name, and description columns, see below) to include a column for the type of property (int, bool, string, etc).
I was reading somewhere about the xsl files that are used for the templates, but honestly it was a little overwhelming trying to find exactly what I'm looking for.
So basically, I'd like to add a column to the above table that lists the type (string, int, etc). Is that possible? Thanks!
Unfortunately after a lot of searching I still haven't been able to find a way to do it exactly as I wanted (as a separate column). The best, as Darraugh pointed out, is to include it manually in the description. There are two ways of doing this. Using the <See>
tag or using the <seealso>
tag.
The <see>
tag can be used as such:
/// <summary>
/// Assessment ID to be copied
/// <see cref="System.Int32">System.Int32</see>
/// </summary>
And produces the following:
The <seealso>
tag can be used as such:
/// <summary>
/// Assessment ID to be copied
/// <seealso cref="System.Int32"/>
/// </summary>
And produces the following:
This is a little redundant since you have to go into the property in order to see it, which already displays the property type.
Hopefully this answer will become obsolete at some point when this is implemented into sandcastle itself. But for right now this may help other as it has helped me.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With