Question

I am using Sandcastle to generate documentation for a project. In order to reference xml documentation file include tag is used.

///<include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
public class Test

And I would like to reference some common content from this XML doc file. For example:

<MyDocs><MyMembers name="test">
        <summary>
           <include file='common.xml' path='MyDocs/MyMembers[@name="test"]/*' />
        </summary>
</MyMembers></MyDocs>

Obviously it does not work this way. What is the right way to do such things? Probably there is some extension for Sandcastle?

Was it helpful?

Solution

Solved the issue by using MAML token files. Sandcastle resolves them without issues.

/// <summary>
/// <token>Token1</token>
/// </summary>
Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top