I wrote some C# XML code documentation and neatly put it all in a separate XML file because it was referenced via <include> statements in template generated code. Why did only the <summary> appear and nothing else in the Sandcastle generated documentation? After a bit of swearing, I eventually noticed the tiny mistake of omitting the trailing /* from the path. A correct <include> statement might be like this:
/// <include file='codedoc.xml' path='MyApp/MyProject/MyClass/member[@name="MyMethod"]/*'/>
Notice the /* suffix. If you accidentally leave that off you only see the first child documentation element, which is probably the <summary>. Very easy to forget and not notice.
No comments:
Post a Comment