Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support <inheritdoc> tag #8589

Merged
merged 6 commits into from
Apr 4, 2023
Merged

feat: support <inheritdoc> tag #8589

merged 6 commits into from
Apr 4, 2023

Conversation

yufeih
Copy link
Contributor

@yufeih yufeih commented Apr 3, 2023

Support <inheritdoc> tag by reusing DocumentationComment in roslyn:

  • Supports cref and path
  • Supports implicit inheritdoc for members

#8558

Fixes #8101 #8129 #7628 #7629 #6366 #7035 #7484 #6995 #8449 #5996 #5909 #8443 #5536 #3699 #5367

@codecov
Copy link

codecov bot commented Apr 3, 2023

Codecov Report

Patch coverage: 93.33% and project coverage change: +0.21 🎉

Comparison is base (05b4d2f) 74.33% compared to head (520ad50) 74.55%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8589      +/-   ##
==========================================
+ Coverage   74.33%   74.55%   +0.21%     
==========================================
  Files         648      647       -1     
  Lines       23933    23825     -108     
==========================================
- Hits        17790    17762      -28     
+ Misses       6143     6063      -80     
Impacted Files Coverage Δ
...t.DocAsCode.Dotnet/ExtractMetadata/MetadataItem.cs 93.93% <ø> (+30.47%) ⬆️
...t.DocAsCode.Dotnet/ExtractMetadata/SyntaxDetail.cs 100.00% <ø> (+78.94%) ⬆️
....DocAsCode.Dotnet/ManagedReference/ApiParameter.cs 100.00% <ø> (+55.55%) ⬆️
...DocAsCode.Dotnet/Resolvers/YamlMetadataResolver.cs 96.33% <ø> (-0.04%) ⬇️
...crosoft.DocAsCode.Dotnet/Visitors/VisitorHelper.cs 88.15% <ø> (-1.50%) ⬇️
...c/Microsoft.DocAsCode.Dotnet/Parsers/XmlComment.cs 77.62% <83.33%> (-3.00%) ⬇️
....DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs 95.18% <100.00%> (+0.05%) ⬆️

... and 1 file with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@yufeih yufeih marked this pull request as ready for review April 3, 2023 14:19
@yufeih yufeih closed this Apr 4, 2023
@yufeih yufeih reopened this Apr 4, 2023
@yufeih yufeih merged commit d850ff5 into main Apr 4, 2023
@yufeih yufeih deleted the inheritdoc branch April 4, 2023 02:07
@yufeih yufeih added the new-feature Makes the pull request to appear in "New Features" section of the next release note label Apr 4, 2023
@rhys-vdw
Copy link

rhys-vdw commented Apr 6, 2023

Legend! 🥇 💪 ❤️

@madsln
Copy link

madsln commented Jun 7, 2023

SirThanksALot! ❤️

p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature Makes the pull request to appear in "New Features" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

inheritdoc fails to inherit params with mismatched types
3 participants