This project has moved and is read-only. For the latest updates, please go here.

Referencing from C# code (docuemtation tags) to Sandcastle content

Topics: Developer Forum, User Forum
Nov 29, 2013 at 5:14 PM
Edited Nov 29, 2013 at 5:20 PM
Hi, I have general questions about how to reference in c# tag documents to Sandcastle content?

I sketched two cases:
///  <see> .... (case 1)_ how to reference code to Sandcastle content e.g.  *.aml document
/// to add as link <see> <seealso>
///  <example> ....
/// (case 2) how to reference to Sandcastle snipets: e.g. *.snippets
///  document with <itemid="ClassDefinition#Define">
/// to ad as <example> or as <code>
public class Foo
    public void Test1()
Thank you for help.
Nov 30, 2013 at 2:56 AM
To link to conceptual content topics, use the conceptualLink element with the ID of the topic.

The MAML codeReference element is not supported in source code. Instead, use the extended attributes on the code element to import the code from an arbitrary file or an actual source code file. If your file is XML as in the snippets file, another alternative is to use the XML comments include element to import the example when the code is built.

See the XML Comments Guide for information on all available XML comments tags. See the Sandcastle MAML guide for information on all available MAML elements.

Marked as answer by mironex on 12/1/2013 at 6:26 AM
Dec 1, 2013 at 2:26 PM
Thank you for you answer.