Copy inherited parameter doc to target if not already present #788
Conversation
This file contains 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
|
Has there been any progress yet? |
|
@Gerrit0 any chance you can get this merged in the coming weeks? I could fork this pull request and fix the conflicts, if that's any help |
|
@StephanBijzitter fixing the conflicts would help a ton, I haven't had time to work on TypeDoc for a few weeks and it'll probably take me a while to get to this otherwise. |
StephanBijzitter
added a commit
to StephanBijzitter/typedoc
that referenced
this pull request
May 13, 2020
Original change by @kayahr in TypeStrong#788 but was deleted before the pull request could be merged.
StephanBijzitter
added a commit
to StephanBijzitter/typedoc
that referenced
this pull request
May 13, 2020
Original change by @kayahr in TypeStrong#788 but was deleted before the pull request could be merged.
Gerrit0
pushed a commit
that referenced
this pull request
May 17, 2020
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.
This change reverses the logic when copying inherited parameter comments. Before this change the source comment was only copied when there was already a target comment. This did not make any sense. Now the source comment is copied when target comment is missing. In this way all parameter documentation is copied when simply using
@inheritDocand it is possible to override specific parameter comments by documenting them with@paramon the target method.PR also includes a unit test for a few common scenarios.
This fixes #787