This project is read-only.
1
Vote

<inheritdoc> to handle a concrete class with a generic base class that implements an interface

description

Here's my situation in pseudo code...
 
interface IFoo
{
/// <summary   This method computes the roundtrip distance. />
double Distance();
}
 
// generic, managed C++ base class where T is an unmanaged type
template<T>
managed class BaseClass : public IFoo
{
 
/// <inheritdoc />
 double Distance()
{
    // implementation in here
}
 
}
 
// managed C++ concrete class
managed class ConcreteClass : BaseClass<unmanagedType>
{
}
 
 
My goal is for the documentation for ConcreteClass.Distance() to be inherited from IFoo.Distance().
 
The error I'm getting for the BaseClass.Distance() is:
[Missing <summary> documentation for "T:Namespace.BaseClass<int>.Distance()"]
 
The error I'm getting for the ConcreteClass.Distance() is:
[Missing <summary> documentation for "M:Namespace.BaseClass<int>.Distance()"]
 
Any suggestions or advice are most welcome!
 
Thanks!

comments

SelormeyPaul wrote Oct 14, 2010 at 11:08 PM

This is SHFB specific problem. SHFB uses its own <inheritdoc/> implementations. Post this to SHFB forum.

EWoodruff wrote Jan 16, 2011 at 2:44 AM

The problem appears to be your <summary> comment. The comment text is within the tag so the words are being treated as attributes rather than inner text. Correcting the comment to put the text between <summary> and </summary> should cause the documentation to show up correctly. It did in my test case. Since this issue is unrelated to Sandcastle, it should be closed here.

wrote Feb 22, 2013 at 1:39 AM