Include common content from xml documentation file

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?

Are you trying to include an XML file from another included XML file? In your examples, it seems to me that the first include adds the second file, and from there you want to include 'common.xml'. Is that so? — Jorge Poveda, Nov 23 '12 at 14:43
I've made a test using Visual Studio 2012, and it does resolve includes on included files, so for me it works as expected. What results do you get when you do it? — Jorge Poveda, Nov 24 '12 at 18:48
@JorgePoveda, I get exactly the same include tag as in summary. Could you provide your example? — k0stya, Dec 26 '12 at 20:38

score 1 · Accepted Answer · answered Dec 26 '12 at 20:43

1

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

/// <summary>
/// <token>Token1</token>
/// </summary>

answered Dec 26 '12 at 20:43

k0stya

4,267
32
41

Include common content from xml documentation file

1 Answers1