Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Missing summary tags for explicitly implemented interfaces?

Basically, I have the following code:

public class MyDictionary<TKey, TValue> : IDictionary<TKey, TValue>
{
    /// <summary> My Summary </summary>
    void MyDictionary<TKey, TValue>.ICollection<KeyValuePair<TKey, TValue>> { ... }
}

MyProject.XML

<member name="M:MyProject.MyDictionary`2.System#Collection#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Clear">
 <summary>
  My Summary
 </summary>
</member>

Sandcastle's Built Output:

Warn: ShowMissingComponent: Missing documentation for M:MyProject.MyDictionary`2.System#Collections#Generic#ICollection{T}#Clear

So, not sure what to do here exactly. I did have my Sandcastle Build Options include explicit implementations, which is why it creates a page for them in the documentation, but it can't seem to figure out that I did create XML Comments for this method. Oddly enough, the void MyDictionary<TKey, TValue>.IDictionary<TKey, TValue>.Add(TKek key, TValue value) method is identified as having XML Comments. In fact, all of the implicitly implemented ICollection> methods are giving Sandcastle an issue. Any help?

like image 951
myermian Avatar asked Sep 14 '11 18:09

myermian


2 Answers

Make sure that your project is building the xml documentation file. There is a check box in the project properties to build the xml file.

enter image description here

like image 138
Timothy Strimple Avatar answered Oct 21 '22 00:10

Timothy Strimple


I'm sure that you tried everything, and I know that you want to know how to do it, but I think it's impossible. It's bug in Sandcastle, and it isn't fixed still.. :(

http://sandcastle.codeplex.com/workitem/5594

like image 20
chopikadze Avatar answered Oct 20 '22 22:10

chopikadze