Improve detection of inherited documentation comments for parameter and return validation #1130
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.
Bug/issue #, if applicable: rdar://134534169
Summary
This uses the same logic that DocC uses elsewhere to detect if a documentation comment is inherited from the current module to avoid validating parameters and return values for inherited documentation comments. Theses warnings won't be actionable since their location isn't from this module's code.
Dependencies
None.
Testing
Build documentation for Outer.docc.zip and pass
--enable-inherited-docs
.There shouldn't be any parameter or return value warnings emitted.
If you want to recreate Outer.symbols.json;
Define two modules; an inner and an outer where the outer depend on the inner.
In the inner module, define a protocol with a func that has parameter and return value warnings:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeededUpdated documentation if necessaryNot applicable.