Added auto-expansion of inheritdoc comments #947
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
February 9, 2021 17:26
…saucecontrol/InheritDoc, so that VS Intellisense picks it up when consumed as package reference.
|
This does not remove warnings from DocFX, will look at those later. |
|
Looked into why warnings are still being produced by DocFX. The reason is that DocFX uses roslyn to re-parse the sources and discards the compiler-generated JsonApiDotNetCore.xml that was produced during solution build. This can be changed in docfx.json by replacing: "files": [ "**/JsonApiDotNetCore.csproj" ],with: "files": [ "src/JsonApiDotNetCore/bin/Release/netcoreapp3.1/JsonApiDotNetCore.dll" ],The upside of that is documentation generation runs a lot faster and handles inheritdoc properly, but the downside is we lose integration with sources on GitHub and some other minor details, so I think it is not worth the change. Before: After: |
maurei
approved these changes
Feb 10, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added auto-expansion of inheritdoc comments using https://github.com/saucecontrol/InheritDoc, so that VS Intellisense picks it up when consumed as package reference.
Fixes #940.