Docfx: /// <inheritdoc />

[richardschneider]

DocFX Version Used:
docfx 2.36.1.0

Template used: (default or statictoc or contain custom template)
default

Steps to Reproduce:

1. git clone https://github.com/richardschneider/net-ipfs-api.git
2. docfx doc\docfx.json

Expected Behavior:

The documentation for Block should inherit the documentation from IDataBlock interface.

Actual Behavior:

No documentation is inherited.

Other:

The docfx.json is fairly standard. It uses a xref to get the IDataBlock documentation.

Here's the links to the generated documentation for Block and IDataBlock and the source code for Block.cs and IDataBlock.cs.

[superyyrrzz]

I find you are referencing IDataBlock through xref. If so, <inheritdoc /> will not work in this case. It requires IDataBlock to be built together with Block to work. You can see the xrefmap.yml doesn't contain IDataBlock's summary, so that DocFX cannot get this information in this case.

[richardschneider]

Are you saying that it is not possible to use <inheritdoc /> on another assembly?

Could you explain how I can get this to work. How can I tell DocFX to get the summary for IDataBlock?

IDataBlock is defined in the Ipfs.Core nuget package, which ships with .xml documentation file .

[superyyrrzz]

This is not supported now. <inheritdoc /> is a feature contributed from community with only basic support (#1178). This should be an improve to look into XML file for summary.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

[rymeskar]

Hi @superyyrrzz ,
I noticed that recently you had been grouping some of the issues regarding xmldoc comments into a specific area.

Could you please share whether we could expect extended support of inheritdoc (including cref and other more granular features)? We are right now considering whether to make some workarounds around this in our code? (mostly revolving around copy-pasting :( )

[superyyrrzz]

Hi @rymeskar , I am grouping them as there are too many issues under label Area-Metadata.

Regarding inheritdoc, it is a syntax from Sandcastle. DocFX does not guarantee to support all Sandcastle syntax, but we are open to community contribution for these.

[rymeskar]

@superyyrrzz Thank you for the explanation. It does make sense having in mind the official VS/Roslyn state of inheritdoc is 'unsupported'.

On the other hand, I would like to let you know that there is quite a lively discussion around Roslyn/VS to add the inheritdoc support natively.

• Deprecated User Voice suggestion with 2800 votes
• Developer Community
• csharplang
• roslyn

[dotMorten]

Regarding inheritdoc, it is a syntax from Sandcastle

Not any more. It's now becoming a 1st class feature in Visual Studio's Intellisense as well:
https://www.youtube.com/watch?v=mg2aocZA9Pc&feature=youtu.be&t=1540

[glennawatson]

It is a first class citizen as of Visual Studio 16.4.

[muhmuhhum]

Are there any updates regarding <inheritdoc> support in docfx ?