Add Type Column to Sandcastle Property Table

So, I am creating a documentation site using the Sandcastle Help File Builder. Everything is created perfectly! However, looking at the page for the class, I would like to get a property table (which currently has a column of icons, names and descriptions, see below) to include a column for the property type (int, bool, string, etc. .).

Properties table

I read somewhere about xsl files that are used for templates, but to be honest, it was a bit strange trying to find exactly what I am looking for.

Basically, I would like to add a column to the above table that shows the type (row, int, etc.). Is it possible? Thanks!

+6
source share
1 answer

Unfortunately, after a great search, I still could not find a way to do this exactly the way I wanted (as a separate column). The best thing, as Darre pointed out, is to include it manually in the description. There are two ways to do this. Using the <See> tag or using the <seealso> .

The <See> can be used as such:

 /// <summary> /// Assessment ID to be copied /// <see cref="System.Int32">System.Int32</see> /// </summary> 

And it produces the following:

<see> sample sample

The <seealso> can be used as such:

 /// <summary> /// Assessment ID to be copied /// <seealso cref="System.Int32"/> /// </summary> 

And it produces the following:

<seealso> tag sample

This is a bit redundant as you have to go into the property to see it, which already displays the type of the property.

I hope this answer becomes obsolete at some point when it will be implemented in the "sand castle". But now it can help others, as it helped me.

+1
source

All Articles