<see> within <c> not shown

Feb 18, 2008 at 11:57 AM
Hi all.

I have a code doc which contains a <see>-tag within a <c>-tag:

/// <remarks>
/// blah blah <c>typeof(<see cref="IEnumerable&lt;T&gt;"/>)</c> blah blah
/// </remarks>

In the XML created by the compiler I see:

blah blah <c>typeof(<see cref="T:System.Collections.Generic.IEnumerable`1" />)</c> blah blah

So far it looks good. But in the resulting .chm file the <see> tag is dropped:

blah blah typeof() blah blah


According to http://www.dynicity.com/Products/XMLDocComments.aspx this this should be legal (at leat this is what I understand). Also x.doc (http://www.codeproject.com/KB/macros/xdoc.aspx) shows it correctly.

I don't know who to blame.
Me, because a <see> in a <c> is illegal?
Sandcastle, because the <see> tag is dropped there?
SHFB, because..?


However, this is a nice-to-have, not a need-to-have. But a hint would be appreciated anyway..


Luki
Coordinator
Feb 18, 2008 at 5:26 PM
Edited Feb 18, 2008 at 5:27 PM
The template for the "c" tag probably only selects the content of the tag as the output and doesn't apply any templates to the content so the <see> tag isn't making it through to the output. Open an issue in the Sandcastle project at http://www.codeplex.com/Sandcastle.

Note that the <code> tag supports <see> tags but it won't work with SHFB because the Code Block Component encodes and colorizes the output first so the <see> tags don't work. That is a SHFB issue and there is no workaround for that with the exception of removing the code block component.

Eric
Feb 19, 2008 at 5:54 AM
Thanks for your answer.

I'll have to live without <see> tag in <c> and <code> blocks. No big thing.

But i'll post it to the sandcastle project anyway. It is no problem if there is no link but the text should imho not be dropped.


Luki