This project is read-only.
2
Vote

Suppress Usage Note for Type Parameter

description

Sandcastle generates an automatic "Usage Note" for each type parameter block, like this:
 
"Usage Note"
"In Visual Basic and C#, you can call this method as an instance method on any object of type IList<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see or ."
 
The two links that apparently should appear at the end ("see ... or ...") are missing in my help file. They are specific to the vs2005 style; hana and Prototype omit the "For more information" part.
 
That doesn't really matter to me, though, since I'd like to suppress this usage note altogether. Is there some switch I overlooked? If not I'd ask to either add one, or simply remove this rather redundant note.
 
For now I've simply deleted the xsl:if blocks following the comment "<!-- usage note for extension methods -->" in all three main_sandcastle.xsl files, and in the main_reference.xsl file for vs2005.

comments

EWoodruff wrote Feb 26, 2011 at 9:03 PM

There is no switch that I'm aware of. Modifying the XSL transformations works for now. The two links are in the form of references to conceptual topics that correspond to the related MSDN topics. Since we don't get those topics and conceptual links are not handled in reference builds, I think they end up being removed and thus the blanks in the sentence. There are a few others throughout the resource items too for other elements (framework notes, variance, covariance, etc.). I think at one point in the past I removed the links. Since those resource items weren't in Hana and Prototype, there were added as part of the Sandcastle Styles patch in the modified form. They could be removed again although I was thinking of replacing them with regular URLs to the related MSDN topics but haven't gotten around to it.

sheir wrote Nov 14, 2011 at 4:35 PM

I have same issue.
Using Sandcastle HFB v1.9.3.0 on a Win7 machine.

I am building for Framework 3.5, help file format of HtmlHelp1 and presentation style of vs2005.

Can someone tell me exactly which file(s) to modify and where they might be located?

Thanks.

sheir wrote Nov 14, 2011 at 6:39 PM

Found the files in Win7 located at
C:\Program Files (x86)\Sandcastle\Presentation\vs2005\transforms
main_reference.xsl
main_sandcastle.xsl

wrote Nov 28, 2011 at 6:26 PM

wrote Feb 22, 2013 at 1:39 AM