How to use <inheritdoc cref=""> to inherit documentation from a C# overload
Question asked by Stephen Haines - May 7 at 1:38 PM
Answered
I want to inherit documentation from an overload of a C# function. However, when I include the overload's signature in the inheritdoc tag (see below) and check the generated documentation in the Comment Preview pane it does not include any documentation derived from the referenced function.
/// <inheritdoc cref="GetIndexOfAny(string,IEnumerable{char},int,int,int,StringComparison,SearchDirection,bool)"/>
So, I'm wondering does anyone know if it is in fact possible to inherit documentation from an overload with GhostDoc?

I'm using GhostDoc Pro 2019.3.19260 in Visual Studio 2019 (Version 16.5.4).

4 Replies

Reply to Thread
0
Misha Zhutov Replied
Employee Post
Hi Stephen,

Currently, GhostDoc finds the base member on its own and using "cref" is not supported at this point but we have it in our backlog.
0
Stephen Haines Replied
OK, thanks Misha
0
Stephen Haines Replied
Hello again Misha

Just wondering if you have an estimated timeline for implementation of support for "cref"? 

I need to improve the documentation of a class library that contains a large number of overloaded functions, and it would be much better and less time consuming to do that using inheritdoc. Is it worth me waiting for support of that by GhostDoc or should I bite the bullet and do it manually?
0
Serge B. Replied
Employee Post Marked As Answer
Hi Stephen,

We have added this to our backlog. Our preliminary investigation indicates this can be done. 

With that said, this most likely will not make it into the next minor update scheduled for mid-summer.

Thanks!
Serge Baranovsky
SubMain Software
(800) 936-2134

Reply to Thread