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

[WIP] Initial implementation of inheritdoc support #64

Closed
wants to merge 3 commits into from

Conversation

sharwell
Copy link
Member

@sharwell sharwell commented Sep 24, 2018

Quite a bit of work remaining here to handle edge cases:

  • General inheritance implementation
    • Handle include elements: translate paths when a relative path will work, otherwise expand the element.
    • Handle recursive inheritdoc elements
    • Define behavior when a library contains <inheritdoc> elements in its documentation
  • inheritdoc (DOC205)
    • Handle overridden root elements
    • Support nesting <inheritdoc> within a root element, e.g. within a <summary> element
    • Support the path/select attributes
    • Support the cref attribute
  • autoinheritdoc (DOC206)
    • Exclusions for overridden root elements, which may be built on path/select support
    • Normalization of text
    • Define behavior for cases where included documentation is not available
    • Support the cref attribute
    • Support placement as a nested element

Closes #16

@codecov
Copy link

codecov bot commented Oct 9, 2018

Codecov Report

Merging #64 into master will increase coverage by 0.01%.
The diff coverage is 82.54%.

@@            Coverage Diff             @@
##           master      #64      +/-   ##
==========================================
+ Coverage   82.26%   82.28%   +0.01%     
==========================================
  Files          71       78       +7     
  Lines        6012     6435     +423     
  Branches      418      449      +31     
==========================================
+ Hits         4946     5295     +349     
- Misses        912      977      +65     
- Partials      154      163       +9

@sharwell
Copy link
Member Author

Now that <inheritdoc> is supported directly by Visual Studio and Roslyn, I'm not sure this feature is needed.

@sharwell sharwell closed this Feb 14, 2021
@sharwell sharwell deleted the inheritdoc branch February 14, 2021 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC205/DOC206: Copy documentation from base member?
1 participant