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

Methods are undocumented when conforming to a protocol. #842

Closed
amosavian opened this issue Jul 2, 2017 · 2 comments
Closed

Methods are undocumented when conforming to a protocol. #842

amosavian opened this issue Jul 2, 2017 · 2 comments

Comments

@amosavian
Copy link

Implemented methods and properties in conforming classes doesn't have inherited description from protocol one. e.g see this one while the protocol has a description.

Also methods from Foundation protocols are marked as undoumented like this one.

@SDGGiesbrecht
Copy link
Contributor

This is a variation of #670. Both issues request special handling of undocumented declarations wherever inheritance is involved. (The difference is that this request asks for the documentation to be automatically inherited, whereas #670 asks for it to be considered redundant and skipped.)

@amosavian, currently Jazzy does not try to understand the inheritance tree. It also does not go looking for dependency modules. Each would be no small task to implement.

If you are looking for a workaround, one of my comments in the other issue may be helpful.

@johnfairh
Copy link
Collaborator

Duplicate of #190, closing.

@johnfairh johnfairh marked this as a duplicate of #190 Jul 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants