see tag is not rendered in the conceptual content

Topics: Developer Forum, User Forum
Aug 9, 2009 at 2:43 AM

eric,

We are using sandcastle to document design at usecase level. So we have custom tag <usecase> defined at the end of each xml comment(as shown below). Using this tag and a custom console application,  I am generating aml files.  In the aml file, i have defined table 2 columns :- Name and Description. In description i am showing contents of summary tag. Now the issue is see tag is not rendered in the conceptual content.  Could you please help me regarding this issue? 

 ''' <summary>

''' This Function will be invoked when the Modify button is clicked in the Summary screen <see cref="KTI.TMIIS.Business.Summary "/>

''' <br></br>

''' <b>Pseudo Code :</b>

''' <br></br>

''' </summary>

''' <param name="iSalesId">Criteria given by the user.</param>

''' <returns>Returns boolean value </returns>

'''<usecase>UC0001_Contracts</usecase>

Coordinator
Aug 9, 2009 at 7:49 PM

The <see> element is not recognized in MAML files.  You need to use the codeEntityReference element instead.  See the MAML Guide available from the Sandcastle Styles project site for more information on how to use it.

Eric