How to Link Conceptual Content in api comment

Oct 21, 2010 at 9:05 AM
Edited Oct 22, 2010 at 4:06 AM

Hi,

I would like to know if it is possible to add a link in the comment of my class to a conceptual content topic, like:

    /// <summary>
    /// MyClass comments and  <see cref="a conceptual content topic"/>
    /// </summary>
    public class MyClass
    {
 
    }

Coordinator
Oct 21, 2010 at 8:39 PM

You need to use an anchor tag and reference the file by its GUID with a ".htm" extension.  See this thread for more information: http://shfb.codeplex.com/Thread/View.aspx?ThreadId=214188

Eric

 

Oct 22, 2010 at 4:09 AM
Edited Oct 22, 2010 at 4:45 AM

 It is good, thanks Eric.

Well how to add a link in a conceptual content topic to the comments of my class by contraries?

I think I have solved this problem, to use "codeEntityReference" , is there any other way or suggestions?

Any way, thank you very much for the excellent tool and your answers, best wishes!

Coordinator
Oct 24, 2010 at 6:55 PM

The codeEntityReference element is the correct way to link to API topics from conceptual topics.  To make them easier to find and insert into the topics, you can use the Entity References window in the GUI.

Eric